|
8 | 8 | <meta property="og:title" content="Contribution Guidelines" />
|
9 | 9 |
|
10 | 10 |
|
11 |
| -<meta property="og:description" content="We do all of our development on GitHub. If you are not familiar with GitHub or pull requests, here is an excellent guide to get started." /> |
| 11 | +<meta property="og:description" content="We do all of our development on |
| 12 | +GitHub. If you are not familiar with |
| 13 | +GitHub or pull requests, here is an excellent guide to get |
| 14 | +started." /> |
12 | 15 |
|
13 | 16 | <meta property="og:url" content="/contributing-code/" />
|
14 | 17 | <meta property="og:type" content="article" />
|
|
29 | 32 |
|
30 | 33 | <meta name="twitter:card" content="summary_large_image" />
|
31 | 34 | <meta name="twitter:title" content="Contribution Guidelines">
|
32 |
| -<meta name="twitter:description" content="We do all of our development on GitHub. If you are not familiar with GitHub or pull requests, here is an excellent guide to get started."> |
| 35 | +<meta name="twitter:description" content="We do all of our development on |
| 36 | +GitHub. If you are not familiar with |
| 37 | +GitHub or pull requests, here is an excellent guide to get |
| 38 | +started."> |
33 | 39 |
|
34 | 40 | <meta name="twitter:site" content="@creativecommons">
|
35 | 41 | <meta name="twitter:creator" content="@creativecommons">
|
|
210 | 216 | <div class="container is-paddingless">
|
211 | 217 | <h1>Contribution Guidelines</h1>
|
212 | 218 | <div class="description column is-9 is-paddingless">
|
213 |
| - <p>We do all of our development <a href="https://github.com/creativecommons/">on GitHub</a>. If you are not familiar with GitHub or pull requests, <a href="https://guides.github.com/activities/hello-world/">here is an excellent guide to get started</a>.</p> |
| 219 | + <p>We do all of our development <a href="https://github.com/creativecommons/">on |
| 220 | +GitHub</a>. If you are not familiar with |
| 221 | +GitHub or pull requests, <a href="https://guides.github.com/activities/hello-world/">here is an excellent guide to get |
| 222 | +started</a>.</p> |
214 | 223 |
|
215 | 224 | </div>
|
216 | 225 | </div>
|
@@ -293,73 +302,122 @@ <h4 class="b-header">On this page</h4>
|
293 | 302 |
|
294 | 303 | </li>
|
295 | 304 |
|
| 305 | + <li> |
| 306 | + <a class="link" href="#donations">Donations</a> |
| 307 | + |
| 308 | + </li> |
| 309 | + |
296 | 310 | </ul>
|
297 | 311 | </aside>
|
298 | 312 | </div>
|
299 | 313 | </div>
|
300 | 314 | <div class="column content is-three-quarters">
|
301 |
| - <h2 id="finding-an-issue">Finding an issue</h2><p>Here's a list of <a href="/projects/">all our current projects</a>. 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.</p> |
302 |
| -<p>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, <a href="/contributing-code/repo-labels/">documented here</a>. Here are some of the ones that are most relevant to finding a good issue to work on:</p> |
| 315 | + <h2 id="finding-an-issue">Finding an issue</h2><p>Here's a list of <a href="/projects/">all our current projects</a>. We use GitHub issues |
| 316 | +associated with each project to track the work associated with that project. |
| 317 | +That's where you can find things to work on.</p> |
| 318 | +<p>We make extensive use of issue labels to designate the priority, status and |
| 319 | +beginner-friendliness of various issues. We have a standard set of labels |
| 320 | +across all projects, <a href="/contributing-code/repo-labels/">documented here</a>. Here |
| 321 | +are some of the ones that are most relevant to finding a good issue to work on:</p> |
303 | 322 | <ul>
|
304 | 323 | <li><strong>Issues available for community contribution:</strong><ul>
|
305 | 324 | <li>The following tags mark issues that are open for community contribution:<ul>
|
306 |
| -<li><span class="gh-label friendliness">help wanted</span> : Open to participation from the community but not necessarily beginner-friendly</li> |
307 |
| -<li><span class="gh-label friendliness">good first issue</span> : Open to participation from the community and friendly towards new contributors</li> |
| 325 | +<li><span class="gh-label friendliness">help wanted</span>: Open to |
| 326 | +participation from the community but not necessarily beginner-friendly</li> |
| 327 | +<li><span class="gh-label friendliness">good first issue</span>: Open to |
| 328 | +participation from the community and friendly towards new contributors</li> |
308 | 329 | </ul>
|
309 | 330 | </li>
|
310 | 331 | <li>You do not need our permission to work on one of these issues.</li>
|
311 |
| -<li>You may work on an issue labeled <span class="gh-label friendliness">good first issue</span> even if it's not your first issue.</li> |
| 332 | +<li>You may work on an issue labeled <span class="gh-label friendliness">good |
| 333 | +first issue</span> even if it's not your first issue.</li> |
312 | 334 | </ul>
|
313 | 335 | </li>
|
314 | 336 | <li><strong>Issues not available for community contribution:</strong><ul>
|
315 |
| -<li>The following tags mark issues that are <em>not</em> open for community contribution:<ul> |
316 |
| -<li><span class="gh-label friendliness">🔒 staff only</span> : Requires infrastructure access or institutional knowledge that would be impractical to provide to the community</li> |
| 337 | +<li>The following tags mark issues that are <em>not</em> open for community |
| 338 | +contribution:<ul> |
| 339 | +<li><span class="gh-label friendliness">🔒 staff only</span>: Requires |
| 340 | +infrastructure access or institutional knowledge that would be |
| 341 | +impractical to provide to the community</li> |
317 | 342 | </ul>
|
318 | 343 | </li>
|
319 | 344 | <li>Do not work on these.</li>
|
320 | 345 | </ul>
|
321 | 346 | </li>
|
322 | 347 | <li><strong>Issues not ready for work:</strong><ul>
|
323 |
| -<li>The following tags mark issues that are <em>not</em> open for community contribution:<ul> |
324 |
| -<li><span class="gh-label status-neutral">🚧 status: blocked</span>: Blocked by other work that needs to be done first</li> |
325 |
| -<li><span class="gh-label status-dark">🧹 status: ticket work required </span>: Needs additional work before it is ready to be taken up</li> |
326 |
| -<li><span class="gh-label status-darker">🚦 status: awaiting triage</span>: Has not been triaged by a maintainer</li> |
| 348 | +<li>The following tags mark issues that are <em>not</em> open for community |
| 349 | +contribution:<ul> |
| 350 | +<li><span class="gh-label status-neutral">🚧 status: blocked</span>: Blocked |
| 351 | +by other work that needs to be done first</li> |
| 352 | +<li><span class="gh-label status-dark">🧹 status: ticket work required |
| 353 | +</span>: Needs additional work before it is ready to be taken up</li> |
| 354 | +<li><span class="gh-label status-darker">🚦 status: awaiting triage</span>: |
| 355 | +Has not been triaged by a maintainer</li> |
327 | 356 | </ul>
|
328 | 357 | </li>
|
329 | 358 | <li>Do not work on these.</li>
|
330 | 359 | </ul>
|
331 | 360 | </li>
|
332 | 361 | <li><strong>Issues without any of the above labels:</strong><ul>
|
333 | 362 | <li>These issues <em>may</em> (or may not) be open for contribution.</li>
|
334 |
| -<li>Please add a comment asking one of the maintainers to triage the issue and label it as appropriate.</li> |
| 363 | +<li>Please add a comment asking one of the maintainers to triage the issue and |
| 364 | +label it as appropriate.</li> |
335 | 365 | </ul>
|
336 | 366 | </li>
|
337 | 367 | </ul>
|
338 |
| -<p>You can use our <a href="/contributing-code/issue-finder/">Issue Finder tool</a> to find a good issue that matches your skills and familiarity with our software and community.</p> |
| 368 | +<p>You can use our <a href="/contributing-code/issue-finder/">Issue Finder tool</a> to find a |
| 369 | +good issue that matches your skills and familiarity with our software and |
| 370 | +community.</p> |
339 | 371 | <p>Some helpful saved searches on GitHub than can assist with finding an issue:</p>
|
340 | 372 | <ul>
|
341 |
| -<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+-linked%3Apr">issues labeled <span class="gh-label friendliness">good first issue</span></a></li> |
342 |
| -<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+-linked%3Apr">issues labeled <span class="gh-label friendliness">help wanted</span></a></li> |
343 |
| -<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Apr+is%3Aopen+label%3A%22help+wanted%22">PRs labeled <span class="gh-label friendliness">help wanted</span></a></li> |
| 373 | +<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+-linked%3Apr">issues labeled <span class="gh-label friendliness">good first |
| 374 | +issue</span></a></li> |
| 375 | +<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+-linked%3Apr">issues labeled <span class="gh-label friendliness">help |
| 376 | +wanted</span></a></li> |
| 377 | +<li><a href="https://github.com/search?q=org%3Acreativecommons+is%3Apr+is%3Aopen+label%3A%22help+wanted%22">PRs labeled <span class="gh-label friendliness">help |
| 378 | +wanted</span></a></li> |
344 | 379 | </ul>
|
345 |
| -<p>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.</p> |
346 |
| -<h2 id="contribution-process">Contribution process</h2><p>Once you've found an issue you'd like to work on, please follow these steps to make your contribution:</p> |
| 380 | +<p>Check the issue comments/labels to see whether someone else has indicated that |
| 381 | +they are working on it. If someone is already working on it and there has been |
| 382 | +activity within the last 7 days, you may want to find a different issue to work |
| 383 | +on.</p> |
| 384 | +<h2 id="contribution-process">Contribution process</h2><p>Once you've found an issue you'd like to work on, please follow these steps to |
| 385 | +make your contribution:</p> |
347 | 386 | <ol>
|
348 |
| -<li>Comment on it and say you're working on that issue. This is to avoid conflicts with others also working on the issue.</li> |
349 |
| -<li>Write your code and submit your pull request. Be sure to read and follow our <strong><a href="/contributing-code/pr-guidelines/">pull request guidelines</a></strong>!</li> |
| 387 | +<li>Comment on it and say you're working on that issue. This is to avoid |
| 388 | +conflicts with others also working on the issue. If you've followed the |
| 389 | +guidelines above, you don't need to ask permission to start work on an |
| 390 | +issue.</li> |
| 391 | +<li>Write your code and submit your pull request. Be sure to read and follow our |
| 392 | +<strong><a href="/contributing-code/pr-guidelines/">pull request guidelines</a>!</strong></li> |
350 | 393 | <li>Wait for code review and address any issues raised as soon as you can.</li>
|
351 | 394 | </ol>
|
352 |
| -<p><strong>A note on collaboration:</strong> We encourage people to collaborate as much as possible. We especially appreciate contributors reviewing each others pull requests, as long as you are <a href="https://medium.com/@otarutunde/comments-during-code-reviews-2cb7791e1ac7">kind and constructive</a> when you do so.</p> |
| 395 | +<p><strong>A note on collaboration:</strong> We encourage people to collaborate as much as |
| 396 | +possible. We especially appreciate contributors reviewing each others pull |
| 397 | +requests, as long as you are <a href="https://medium.com/@otarutunde/comments-during-code-reviews-2cb7791e1ac7">kind and constructive</a> when you |
| 398 | +do so.</p> |
353 | 399 | <h2 id="proposing-a-new-issue">Proposing a new issue</h2><p>If you want to work on something that there is no GitHub issue for, follow these steps:</p>
|
354 | 400 | <ol>
|
355 |
| -<li>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.<ul> |
356 |
| -<li>We are very reluctant to accept random pull requests without a related issue created first.</li> |
| 401 | +<li>Create a new GitHub issue associated with the relevant repository and |
| 402 | +propose your change there. Be sure to include implementation details and the |
| 403 | +rationale for the proposed change.<ul> |
| 404 | +<li>We are very reluctant to accept random pull requests without a related |
| 405 | +issue created first.</li> |
357 | 406 | </ul>
|
358 | 407 | </li>
|
359 |
| -<li>The issue will automatically have the <span class="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.</li> |
360 |
| -<li>Once the project maintainer has approved the issue and removed the <span class="gh-label status-darker">🚦 status: awaiting triage</span> label, you may start work on code as described in the "Contribution process" section above.</li> |
| 408 | +<li>The issue will automatically have the <span class="gh-label |
| 409 | +status-darker">🚦 status: awaiting triage</span> label applied. Wait for a |
| 410 | +project maintainer to evaluate your issue and decide whether it's something |
| 411 | +that we will accept a pull request for.</li> |
| 412 | +<li>Once the project maintainer has approved the issue and removed the <span |
| 413 | +class="gh-label status-darker">🚦 status: awaiting triage</span> label, you |
| 414 | +may start work on code as described in the "Contribution process" section |
| 415 | +above.</li> |
361 | 416 | </ol>
|
362 | 417 | <p>When in doubt, ask a question on <a href="/community/">one of our community forums</a>.</p>
|
| 418 | +<h2 id="donations">Donations</h2><p>Recurring donations to Creative Commons Open Source can be made via <a href="https://github.com/sponsors/creativecommons">Sponsor |
| 419 | +@creativecommons on GitHub |
| 420 | +Sponsors</a>.</p> |
363 | 421 |
|
364 | 422 | </div>
|
365 | 423 | </div>
|
|
0 commit comments