You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/blog/entries/2023-03-24-community-contributions/contents.lr
+58-23
Original file line number
Diff line number
Diff line change
@@ -24,33 +24,68 @@ Documentation can always use improvements whether within code comments, a projec
24
24
25
25
Whether an Error or Feature/functionality Issue, once it's been submitted, in accordance with the [Contribution Guidelines](https://opensource.creativecommons.org/contributing-code/), it will move to a status of "awaiting triage". This means that it is waiting to be reviewed by one of the core codebase contributors. While it's in this state no implementation work should be done (no PRs, no code work to add or correct the behavior). An Issue submitted is largely the start of a process, and a conversation. Core contributors will review the Issue and see if it adequately describes its appropriate details, and if its objectives fit within the larger pattern and goals of the codebase itself. It's entirely possible that a well thought through Feature Issue that adds some new menu functionality is in isolation a good idea, but that it doesn't fit within the goals of the project in question and won't move forward. And that's OK, even if an Issue doesn't move forward it can now stand as documentation for the community on what won't be worked on at this time, which is just as important as what will. It's a contribution whether it moves forward or not, so long as it describes itself well enough.
26
26
27
-
If this happens, the Issue will be moved to a status of "discarded", and will be closed with a comment explaining why. The other reason an Issue might be moved to "discarded" is that it duplicates the work in another Issue, which is why it's important to first check all the existing Issues prior to submitting a new one.
28
-
29
-
Sometimes an Issue might describe something much broader than can be easily contained within itself and may be converted to a status of "discussion". This means that the Issue should spark a larger conversation within the community to consider all the angles of abstract, and possibly split the idea up into more manageable pieces across multiple Issues. Other outcomes might be a discussion that realizes that while the idea is sound, it's not implementable at this time and won't move forward.
30
-
31
-
Some Issues are solid ideas, but they are not something that can move forward until work on other Issues is completed first. As such they tend to move to a status of "blocked". They'll sit in that state until they're unblocked and the work can happen.
32
-
33
-
If an Issue seems like it doesn't have enough information to determine what to do with it, then it will likely move to a status of "ticket work required" and a comment will usually be left describing what needs to be worked on.
34
-
35
-
Remember, an Issue is a form of documentation, and in a way it's a conversation, and that means that until it moves forward it's very much a work in progress.
36
-
37
-
If an Issue passes through this period as implementable, then it'll move to a status of "ready for work". This is the point at which it can be implemented, and a contributor can submit a Pull Request addressing it. (See the [Repository Labels Status section](https://opensource.creativecommons.org/contributing-code/repo-labels/#status) for more information )
38
-
39
-
During this process it is worth noting that there will be multiple types of contribution. For example:
27
+
If this happens, the Issue will be moved to a status of "discarded", and will
28
+
be closed with a comment explaining why. The other reason an Issue might be
29
+
moved to "discarded" is that it duplicates the work in another Issue, which
30
+
is why it's important to first check all the existing Issues prior to
31
+
submitting a new one.
32
+
33
+
Sometimes an Issue might describe something much broader than can be easily
34
+
contained within itself and may be converted to a status of "discussion". This
35
+
means that the Issue should spark a larger conversation within the community
36
+
to consider all the angles of abstract, and possibly split the idea up into
37
+
more manageable pieces across multiple Issues. Other outcomes might be a
38
+
discussion that realizes that while the idea is sound, it's not implementable
39
+
at this time and won't move forward.
40
+
41
+
Some Issues are solid ideas, but they are not something that can move forward
42
+
until work on other Issues is completed first. As such they tend to move to a
43
+
status of "blocked". They'll sit in that state until they're unblocked and the
44
+
work can happen.
45
+
46
+
If an Issue seems like it doesn't have enough information to determine what to
47
+
do with it, then it will likely move to a status of "ticket work required" and a comment will usually be left describing what needs to be worked on.
48
+
49
+
Remember, an Issue is a form of documentation, and in a way it's a
50
+
conversation, and that means that until it moves forward it's very much a
51
+
work in progress.
52
+
53
+
If an Issue passes through this period as implementable, then it'll move to a
54
+
status of "ready for work". This is the point at which it can be implemented,
55
+
and a contributor can submit a Pull Request addressing it. (See the
56
+
[Repository Labels Status section](https://opensource.creativecommons.org/co
57
+
ntributing-code/repo-labels/#status) for more information)
58
+
59
+
During this process it is worth noting that there will be multiple types of
60
+
contribution. For example:
40
61
41
62
* The Issue itself is a contribution
42
63
* Comments on the Issue from the community refining it are each contributions
43
-
* Someone's comment on the Issue helping another person sort out why the Error is occurring is a contribution.
44
-
* Someone finding another related Issue and linking it as relevant to that Issue is a contribution.
45
-
46
-
All of these contributions occurred before a Pull Request was ever initiated. Once an Issue enters a status of "ready for work" someone who has indicated interest on that Issue will be assigned to it and can then fork the repository, make a branch to work within, and once settled submit a Pull Request. That process alone may involve several contributions as well, such as:
47
-
48
-
* The code work encounters a problem, someone asks for assistance within their draft PR, and several members offer help as comments.
49
-
* Someone reviews the final PR and leaves a detailed review on what might need addressing
50
-
* A discussion breaks out on the best way to resolve an encountered problem with the PR, each of these comments is a contribution
64
+
* Someone's comment on the Issue helping another person sort out why the Error
65
+
is occurring is a contribution.
66
+
* Someone finding another related Issue and linking it as relevant to that
67
+
Issue is a contribution.
68
+
69
+
All of these contributions occurred before a Pull Request was ever initiated.
70
+
Once an Issue enters a status of "ready for work" someone who has indicated
71
+
interest on that Issue will be assigned to it and can then fork the
72
+
repository, make a branch to work within, and once settled submit a Pull
73
+
Request. That process alone may involve several contributions as well, such
74
+
as:
75
+
76
+
* The code work encounters a problem, someone asks for assistance within their
77
+
draft PR, and several members offer help as comments.
78
+
* Someone reviews the final PR and leaves a detailed review on what might need
79
+
addressing
80
+
* A discussion breaks out on the best way to resolve an encountered problem
81
+
with the PR, each of these comments is a contribution
51
82
* And, of course, the PR itself is a contribution.
52
83
53
-
If the PR passes Review then it'll be marked as Approved and merged into the codebase, that will trigger the associated Issue to close as complete and now the Error Fix or Functionality in question will be fully implemented into the project.
84
+
If the PR passes Review then it'll be marked as Approved and merged into the
85
+
codebase, that will trigger the associated Issue to close as complete and now
86
+
the Error Fix or Functionality in question will be fully implemented into
87
+
the project.
54
88
55
-
To get here it took multiple contributions, from different community members, that's the power of open source!
89
+
To get here it took multiple contributions, from different community members,
0 commit comments