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: contributing-code/pr-guidelines/index.html
+33-18Lines changed: 33 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -223,18 +223,21 @@ <h2>On this page</h2>
223
223
</aside>
224
224
225
225
<divclass="content">
226
-
<p>Read and follow the contributing guidelines and code of conduct for the project. Here are screenshots of where to find them for <ahref="/contributing-code/pr-guidelines/first-time-contributor-resources.png">first time contributors</a> and <ahref="/contributing-code/pr-guidelines/previous-contributor-resources.png">previous contributors</a>.</p>
227
-
<p>We aim to review pull requests within five business days.<ahref="#footnote-1"><strong>*</strong></a>. If it has been over five business days and you have not received any feedback, feel free to follow up with us.</p>
226
+
<!-- disregard: vim syntax highlighting fix_ -->
227
+
228
+
<p>Read and follow the contributing guidelines and code of conduct for the project. Here are screenshots of where to find them for <ahref="/contributing-code/pr-guidelines/first-time-contributor-resources.png">first time contributors</a> and <ahref="/contributing-code/pr-guidelines/previous-contributor-resources.png">previous contributors</a>.</p>
229
+
<p>We aim to review pull requests within five business days.<supclass="footnote-ref" id="fnref-business-days"><ahref="#fn-business-days">1</a></sup> If it has been over five business days and you have not received any feedback, feel free to follow up with us.</p>
228
230
<ul>
229
231
<li><strong>Make A Branch</strong><ul>
230
232
<li>Please create a separate branch for each issue that you're working on. Do not make changes to the default branch (e.g. <code>master</code>, <code>develop</code>) of your fork.</li>
231
233
</ul>
232
234
</li>
233
-
<li><strong>Push Your Code ASAP</strong><ul>
234
-
<li>Push your code as soon as you can. Follow the "<ahref="https://www.worklytics.co/blog/commit-early-push-often/">early and often</a>" rule. </li>
235
-
<li>Make a pull request as soon as you can and <strong>mark the title with a "[WIP]"</strong>. You can create a <ahref="https://help.github.com/en/articles/about-pull-requests#draft-pull-requests">draft pull request</a>.
236
-
<br/>
237
-
<ahref="/contributing-code/pr-guidelines/draft_pr.gif">Screenshot: How to create draft PR?</a></li>
235
+
<li><strong>Push Your Code ASAP</strong><ul>
236
+
<li>Push your code as soon as you can. Follow the "<ahref="https://www.worklytics.co/blog/commit-early-push-often/">early and often</a>" rule.</li>
237
+
<li>Make a pull request as soon as you can and <strong>mark the title with a "[WIP]"</strong>. You can create a <ahref="https://help.github.com/en/articles/about-pull-requests#draft-pull-requests">draft pull request</a>.<ul>
238
+
<li><ahref="/contributing-code/pr-guidelines/draft_pr.gif">Screenshot: How to create draft PR?</a></li>
239
+
</ul>
240
+
</li>
238
241
</ul>
239
242
</li>
240
243
<li><strong>Describe Your Pull Request</strong><ul>
@@ -249,24 +252,31 @@ <h2>On this page</h2>
249
252
</li>
250
253
<li>Describe your change in detail. Too much detail is better than too little.</li>
251
254
<li>Describe how you tested your change.</li>
252
-
<li>Check the Preview tab to make sure the Markdown is correctly rendered and that all tags and references are linked. If not, go back and edit the Markdown.
<li>Check the Preview tab to make sure the Markdown is correctly rendered and that all tags and references are linked. If not, go back and edit the Markdown.<ul>
<li>Once your PR is ready, <strong>remove the "[WIP]" from the title</strong> and/or change it from a draft PR to a regular PR.</li>
262
+
<li>Once your PR is ready, <strong>remove the "[WIP]" from the title</strong> and/or change it from a draft PR to a regular PR.<ul>
263
+
<li>To be ready, any code must execute and complete successfully on your machine</li>
264
+
<li>To be ready, you should have already reviewed the <strong>Files changed</strong> tab for unintended files and other obvious mistakes</li>
265
+
</ul>
266
+
</li>
259
267
<li>If a specific reviewer is not assigned automatically, please <ahref="https://help.github.com/en/articles/requesting-a-pull-request-review">request a review</a> from the project maintainer and any other interested parties manually.</li>
260
268
</ul>
261
269
</li>
262
270
<li><strong>Incorporating feedback</strong><ul>
263
271
<li>If your PR gets a 'Changes requested' review, you will need to address the feedback and update your PR by pushing to the same branch. You don't need to close the PR and open a new one.</li>
264
-
<li>Be sure to <strong>re-request review</strong> once you have made changes after a code review.
265
-
<br/>
266
-
<ahref="/contributing-code/pr-guidelines/rereview.png">Screenshot: How to request re-review?</a></li>
267
-
<li>Asking for a re-review makes it clear that you addressed the changes that were requested and that it's waiting on the maintainers instead of the other way round.
268
-
<br/>
269
-
<ahref="/contributing-code/pr-guidelines/difference.png">Screenshot: Difference between 'Changes requested' and 'Review required'</a></li>
272
+
<li>Be sure to <strong>re-request review</strong> once you have made changes after a code review.<ul>
273
+
<li><ahref="/contributing-code/pr-guidelines/rereview.png">Screenshot: How to request re-review?</a></li>
274
+
</ul>
275
+
</li>
276
+
<li>Asking for a re-review makes it clear that you addressed the changes that were requested and that it's waiting on the maintainers instead of the other way round.<ul>
277
+
<li><ahref="/contributing-code/pr-guidelines/difference.png">Screenshot: Difference between 'Changes requested' and 'Review required'</a></li>
<pclass="caption"><aname="footnote-1" class="has-color-dark-slate-gray"><strong>*</strong></a> CC staff work Monday through Friday and are not available on weekends and national holidays (the specific holidays observed vary based on the person's location). CC is closed between Christmas Eve and New Years' Day every year and for a few days following the CC Global Summit. Also, our availability during events such as the CC Global Summit and our biannual staff meetups is limited.</p>
299
+
<divclass="footnotes">
300
+
<hr>
301
+
<ol><liid="fn-business-days"><p>CC staff work Monday through Friday and are not available on weekends and national holidays (the specific holidays observed vary based on the person's location). CC is closed between Christmas Eve and New Years' Day every year. Also, our availability during events such as staff meetups is limited.<ahref="#fnref-business-days" class="footnote">↩</a></p></li>
0 commit comments