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/contributing-code/contents.lr
+27-17
Original file line number
Diff line number
Diff line change
@@ -13,28 +13,38 @@ body:
13
13
14
14
Here's a list of [all our current projects](/projects/). We use GitHub issues associated with each project to track the work associated with that project. That's where you can find things to work on.
15
15
16
-
We make extensive use of issue labels to desginate the status of various issues. We have a standard set of labels across all projects, [documented here](https://github.com/creativecommons/ccos-scripts/blob/master/normalize_repos/labels.py). Here are some of the ones that are most relevant to finding a good issue to work on:
17
-
18
-
***Issues tagged `help wanted` or `good first issue`** are available for community contribution**
19
-
* These issues are available for community contribution and you do not need our permission to work on one of these.
20
-
* You may work on an issue labeled `good first issue` even if it's not your first issue.
21
-
* Check the issue comments/labels to see whether someone else has indicated that they are working on it. If someone is already working on it and there has been activity within the last 7 days, you may want to find a different issue to work on.
22
-
***Issues tagged with one of these labels: `blocked`, `not ready for work`, `ticket work required`, `CC staff only` are not available to the community. Do not work on these.**
23
-
* Issues tagged `blocked` are blocked by other work that needs to be done first.
24
-
* Issues tagged `not ready for work` or `ticket work required` need additional work done on the issue before they can be opened to community contributors.
25
-
* Issues tagged `CC staff only` are not suitable for community contribution, usually because it requires infrastructure access or institutional knowledge that would be impractical to provide to the community.
26
-
***Issues without any of the above labels _may_ be open for contribution.**
27
-
* Please add a comment to ask whether the issue is available before starting work.
16
+
We make extensive use of issue labels to designate the priority, status and beginner-friendliness of various issues. We have a standard set of labels across all projects, [documented here](https://github.com/creativecommons/ccos-scripts/blob/master/normalize_repos/labels.json). Here are some of the ones that are most relevant to finding a good issue to work on:
17
+
18
+
-**Issues available for community contribution:**
19
+
- The following tags mark issues that are open for community contribution:
20
+
-`help wanted`: Open to participation from the community but not necessarily beginner-friendly
21
+
-`good first issue`: Open to participation from the community and friendly towards new contributors
22
+
- You do not need our permission to work on one of these issues.
23
+
- You may work on an issue labeled `good first issue` even if it's not your first issue.
24
+
***Issues not available for community contribution:**
25
+
- The following tags mark issues that are _not_ open for community contribution:
26
+
-`🔒 staff only`: Requires infrastructure access or institutional knowledge that would be impractical to provide to the community
27
+
- Do not work on these.
28
+
-**Issues not ready for work:**
29
+
- The following tags mark issues that are _not_ open for community contribution:
30
+
-`🚧 blocked`: Blocked by other work that needs to be done first
31
+
-`🧹 ticket work required`: Needs additional work before it is ready to be taken up
32
+
-`🚦 awaiting triage`: Has not been triaged by a maintainer
33
+
- Do not work on these.
34
+
-**Issues without any of the above labels:**
35
+
- These issues _may_ (or may not) be open for contribution.
36
+
- Please add a comment asking one of the maintainers to triage the issue and label it as appropriate.
28
37
29
38
Some helpful saved searches on GitHub than can assist with finding an issue:
30
-
-[issues labeled "good first issue"](https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
-[issues labeled "help wanted", and not labeled as "in progress"](https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+-label%3A%22in+progress%22)
-[issues labeled "good first issue"](https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+-linked%3Apr)
Check the issue comments/labels to see whether someone else has indicated that they are working on it. If someone is already working on it and there has been activity within the last 7 days, you may want to find a different issue to work on.
34
44
35
45
## Contribution process
36
46
37
-
Once you've found an issue you'd like to work on, please follow these steps to make your contribution:
47
+
Once you've found an issue you'd like to work on, and is not already in progress, please follow these steps to make your contribution:
38
48
39
49
1. Comment on it and say you're working on that issue. This is to avoid conflicts with others also working on the issue.
40
50
* A project maintainer may mark the issue with an `in progress` label at this point, but we don't always get around to that.
0 commit comments