Skip to content

Commit 4ddde7f

Browse files
committed
Synchronized build
1 parent fa89c4a commit 4ddde7f

File tree

1 file changed

+33
-18
lines changed

1 file changed

+33
-18
lines changed

contributing-code/pr-guidelines/index.html

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -223,18 +223,21 @@ <h2>On this page</h2>
223223
</aside>
224224

225225
<div class="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 <a href="/contributing-code/pr-guidelines/first-time-contributor-resources.png">first time contributors</a> and <a href="/contributing-code/pr-guidelines/previous-contributor-resources.png">previous contributors</a>.</p>
227-
<p>We aim to review pull requests within five business days.<a href="#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 <a href="/contributing-code/pr-guidelines/first-time-contributor-resources.png">first time contributors</a> and <a href="/contributing-code/pr-guidelines/previous-contributor-resources.png">previous contributors</a>.</p>
229+
<p>We aim to review pull requests within five business days.<sup class="footnote-ref" id="fnref-business-days"><a href="#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>
228230
<ul>
229231
<li><strong>Make A Branch</strong><ul>
230232
<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>
231233
</ul>
232234
</li>
233-
<li><strong>Push Your Code ASAP</strong> <ul>
234-
<li>Push your code as soon as you can. Follow the "<a href="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 <a href="https://help.github.com/en/articles/about-pull-requests#draft-pull-requests">draft pull request</a>.
236-
<br/>
237-
<a href="/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 "<a href="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 <a href="https://help.github.com/en/articles/about-pull-requests#draft-pull-requests">draft pull request</a>.<ul>
238+
<li><a href="/contributing-code/pr-guidelines/draft_pr.gif">Screenshot: How to create draft PR?</a></li>
239+
</ul>
240+
</li>
238241
</ul>
239242
</li>
240243
<li><strong>Describe Your Pull Request</strong><ul>
@@ -249,24 +252,31 @@ <h2>On this page</h2>
249252
</li>
250253
<li>Describe your change in detail. Too much detail is better than too little.</li>
251254
<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.
253-
<br/>
254-
<a href="/contributing-code/pr-guidelines/populated_pr.png">Screenshot: Populated pull request</a></li>
255+
<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>
256+
<li><a href="/contributing-code/pr-guidelines/populated_pr.png">Screenshot: Populated pull request</a></li>
257+
</ul>
258+
</li>
255259
</ul>
256260
</li>
257261
<li><strong>Request Review</strong><ul>
258-
<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>
259267
<li>If a specific reviewer is not assigned automatically, please <a href="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>
260268
</ul>
261269
</li>
262270
<li><strong>Incorporating feedback</strong><ul>
263271
<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-
<a href="/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-
<a href="/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><a href="/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><a href="/contributing-code/pr-guidelines/difference.png">Screenshot: Difference between 'Changes requested' and 'Review required'</a></li>
278+
</ul>
279+
</li>
270280
</ul>
271281
</li>
272282
</ul>
@@ -286,7 +296,12 @@ <h2 id="code-guidelines">Code guidelines</h2><ul>
286296
</ul>
287297
</li>
288298
</ul>
289-
<p class="caption"><a name="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+
<div class="footnotes">
300+
<hr>
301+
<ol><li id="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.<a href="#fnref-business-days" class="footnote">&#8617;</a></p></li>
302+
</ol>
303+
</div>
304+
290305
</div>
291306

292307

0 commit comments

Comments
 (0)