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
+87-28
Original file line number
Diff line number
Diff line change
@@ -4,63 +4,122 @@ _template: page-with-toc.html
4
4
---
5
5
title: Contribution Guidelines
6
6
---
7
-
description: We do all of our development [on GitHub](https://github.com/creativecommons/). If you are not familiar with GitHub or pull requests, [here is an excellent guide to get started](https://guides.github.com/activities/hello-world/).
7
+
description: We do all of our development [on
8
+
GitHub](https://github.com/creativecommons/). If you are not familiar with
9
+
GitHub or pull requests, [here is an excellent guide to get
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.
17
+
Here's a list of [all our current projects](/projects/). We use GitHub issues
18
+
associated with each project to track the work associated with that project.
19
+
That's where you can find things to work on.
15
20
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](/contributing-code/repo-labels/). Here are some of the ones that are most relevant to finding a good issue to work on:
21
+
We make extensive use of issue labels to designate the priority, status and
22
+
beginner-friendliness of various issues. We have a standard set of labels
23
+
across all projects, [documented here](/contributing-code/repo-labels/). Here
24
+
are some of the ones that are most relevant to finding a good issue to work on:
17
25
18
26
-**Issues available for community contribution:**
19
27
- The following tags mark issues that are open for community contribution:
20
-
- <spanclass="gh-label friendliness">help wanted</span> : Open to participation from the community but not necessarily beginner-friendly
21
-
- <spanclass="gh-label friendliness">good first issue</span> : Open to participation from the community and friendly towards new contributors
28
+
- <spanclass="gh-label friendliness">help wanted</span>: Open to
29
+
participation from the community but not necessarily beginner-friendly
30
+
- <spanclass="gh-label friendliness">good first issue</span>: Open to
31
+
participation from the community and friendly towards new contributors
22
32
- You do not need our permission to work on one of these issues.
23
-
- You may work on an issue labeled <spanclass="gh-label friendliness">good first issue</span> 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
-
- <spanclass="gh-label friendliness">🔒 staff only</span> : Requires infrastructure access or institutional knowledge that would be impractical to provide to the community
33
+
- You may work on an issue labeled <spanclass="gh-label friendliness">good
34
+
first issue</span> even if it's not your first issue.
35
+
-**Issues not available for community contribution:**
36
+
- The following tags mark issues that are _not_ open for community
- 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.
37
-
38
-
You can use our [Issue Finder tool](/contributing-code/issue-finder/) to find a good issue that matches your skills and familiarity with our software and community.
54
+
- Please add a comment asking one of the maintainers to triage the issue and
55
+
label it as appropriate.
56
+
57
+
You can use our [Issue Finder tool](/contributing-code/issue-finder/) to find a
58
+
good issue that matches your skills and familiarity with our software and
59
+
community.
39
60
40
61
Some helpful saved searches on GitHub than can assist with finding an issue:
41
-
-[issues labeled <spanclass="gh-label friendliness">good first issue</span>](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.
46
78
47
79
## Contribution process
48
80
49
-
Once you've found an issue you'd like to work on, please follow these steps to make your contribution:
81
+
Once you've found an issue you'd like to work on, please follow these steps to
82
+
make your contribution:
50
83
51
-
1. Comment on it and say you're working on that issue. This is to avoid conflicts with others also working on the issue.
52
-
2. Write your code and submit your pull request. Be sure to read and follow our **[pull request guidelines](/contributing-code/pr-guidelines/)**!
84
+
1. Comment on it and say you're working on that issue. This is to avoid
85
+
conflicts with others also working on the issue. If you've followed the
86
+
guidelines above, you don't need to ask permission to start work on an
87
+
issue.
88
+
2. Write your code and submit your pull request. Be sure to read and follow our
3. Wait for code review and address any issues raised as soon as you can.
54
91
55
-
**A note on collaboration:** We encourage people to collaborate as much as possible. We especially appreciate contributors reviewing each others pull requests, as long as you are [kind and constructive](https://medium.com/@otarutunde/comments-during-code-reviews-2cb7791e1ac7) when you do so.
92
+
**A note on collaboration:** We encourage people to collaborate as much as
93
+
possible. We especially appreciate contributors reviewing each others pull
94
+
requests, as long as you are [kind and constructive][review-comments] when you
If you want to work on something that there is no GitHub issue for, follow these steps:
60
103
61
-
1. Create a a new GitHub issue associated with the relevant repository and propose your change there. Be sure to include implementation details and the rationale for the proposed change.
62
-
* We are very reluctant to accept random pull requests without a related issue created first.
63
-
2. The issue will automatically have the <spanclass="gh-label status-darker">🚦 status: awaiting triage</span> label applied. Wait for a project maintainer to evaluate your issue and decide whether it's something that we will accept a pull request for.
64
-
3. Once the project maintainer has approved the issue and removed the <spanclass="gh-label status-darker">🚦 status: awaiting triage</span> label, you may start work on code as described in the "Contribution process" section above.
104
+
1. Create a new GitHub issue associated with the relevant repository and
105
+
propose your change there. Be sure to include implementation details and the
106
+
rationale for the proposed change.
107
+
- We are very reluctant to accept random pull requests without a related
108
+
issue created first.
109
+
2. The issue will automatically have the <span class="gh-label
110
+
status-darker">🚦 status: awaiting triage</span> label applied. Wait for a
111
+
project maintainer to evaluate your issue and decide whether it's something
112
+
that we will accept a pull request for.
113
+
3. Once the project maintainer has approved the issue and removed the <span
114
+
class="gh-label status-darker">🚦 status: awaiting triage</span> label, you
115
+
may start work on code as described in the "Contribution process" section
116
+
above.
65
117
66
118
When in doubt, ask a question on [one of our community forums](/community/).
119
+
120
+
121
+
## Donations
122
+
123
+
Recurring donations to Creative Commons Open Source can be made via [Sponsor
0 commit comments