Skip to content

Commit eca11e9

Browse files
committed
update formatting and add "to be ready..." items to "Request Review"
1 parent 0cb6e02 commit eca11e9

File tree

1 file changed

+41
-43
lines changed

1 file changed

+41
-43
lines changed

content/contributing-code/pr-guidelines/contents.lr

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -11,59 +11,57 @@ for pull requests; following them will expedite the process of merging your
1111
code in.
1212
[github-pr]: https://help.github.com/en/articles/about-pull-requests
1313
---
14-
body:
14+
body: <!-- disregard: vim syntax highlighting fix_ -->
1515

1616
Read and follow the contributing guidelines and code of conduct for the project. Here are screenshots of where to find them for [first time contributors](first-time-contributor-resources.png) and [previous contributors](previous-contributor-resources.png).
1717

18-
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.
18+
We aim to review pull requests within five business days.[^business-days] If it has been over five business days and you have not received any feedback, feel free to follow up with us.
1919

20-
* **Make A Branch**
21-
* Please create a separate branch for each issue that you're working on. Do not make changes to the default branch (e.g. `master`, `develop`) of your fork.
22-
* **Push Your Code ASAP**
23-
* Push your code as soon as you can. Follow the "[early and often](https://www.worklytics.co/blog/commit-early-push-often/)" rule.
24-
* Make a pull request as soon as you can and **mark the title with a "[WIP]"**. You can create a [draft pull request](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests).
25-
<br/>
26-
[Screenshot: How to create draft PR?](draft_pr.gif)
27-
* **Describe Your Pull Request**
28-
* Use the format specified in pull request template for the repository. **Populate the stencil completely** for maximum verbosity.
29-
* Tag the actual issue number by replacing `#[issue_number]` e.g. `#42`.
20+
- **Make A Branch**
21+
- Please create a separate branch for each issue that you're working on. Do not make changes to the default branch (e.g. `master`, `develop`) of your fork.
22+
- **Push Your Code ASAP**
23+
- Push your code as soon as you can. Follow the "[early and often](https://www.worklytics.co/blog/commit-early-push-often/)" rule.
24+
- Make a pull request as soon as you can and **mark the title with a "[WIP]"**. You can create a [draft pull request](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests).
25+
- [Screenshot: How to create draft PR?](draft_pr.gif)
26+
- **Describe Your Pull Request**
27+
- Use the format specified in pull request template for the repository. **Populate the stencil completely** for maximum verbosity.
28+
- Tag the actual issue number by replacing `#[issue_number]` e.g. `#42`.
3029
This closes the issue when your PR is merged.
31-
* Tag the actual issue author by replacing `@[author]` e.g. `@issue_author`.
30+
- Tag the actual issue author by replacing `@[author]` e.g. `@issue_author`.
3231
This brings the reporter of the issue into the conversation.
33-
* Mark the tasks off your checklist by adding an `x` in the `[ ]` e.g. `[x]`.
32+
- Mark the tasks off your checklist by adding an `x` in the `[ ]` e.g. `[x]`.
3433
This checks off the boxes in your to-do list. The more boxes you check, the better.
35-
* Describe your change in detail. Too much detail is better than too little.
36-
* Describe how you tested your change.
37-
* 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.
38-
<br/>
39-
[Screenshot: Populated pull request](populated_pr.png)
40-
* **Request Review**
41-
* Once your PR is ready, **remove the "[WIP]" from the title** and/or change it from a draft PR to a regular PR.
42-
* If a specific reviewer is not assigned automatically, please [request a review](https://help.github.com/en/articles/requesting-a-pull-request-review) from the project maintainer and any other interested parties manually.
43-
* **Incorporating feedback**
44-
* 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.
45-
* Be sure to **re-request review** once you have made changes after a code review.
46-
<br/>
47-
[Screenshot: How to request re-review?](rereview.png)
48-
* 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.
49-
<br/>
50-
[Screenshot: Difference between 'Changes requested' and 'Review required'](difference.png)
34+
- Describe your change in detail. Too much detail is better than too little.
35+
- Describe how you tested your change.
36+
- 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.
37+
- [Screenshot: Populated pull request](populated_pr.png)
38+
- **Request Review**
39+
- Once your PR is ready, **remove the "[WIP]" from the title** and/or change it from a draft PR to a regular PR.
40+
- To be ready, any code must execute and complete successfully on your machine
41+
- To be ready, you should have already reviewed the **Files changed** tab for unintended files and other obvious mistakes
42+
- If a specific reviewer is not assigned automatically, please [request a review](https://help.github.com/en/articles/requesting-a-pull-request-review) from the project maintainer and any other interested parties manually.
43+
- **Incorporating feedback**
44+
- 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.
45+
- Be sure to **re-request review** once you have made changes after a code review.
46+
- [Screenshot: How to request re-review?](rereview.png)
47+
- 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.
48+
- [Screenshot: Difference between 'Changes requested' and 'Review required'](difference.png)
5149

5250

5351
## Code guidelines
5452

55-
* Write comprehensive and robust tests that cover the changes you've made in your work.
56-
* Follow the appropriate code style standards for the language and framework you're using (e.g. PEP 8 for Python).
57-
* Write readable code – keep functions small and modular and name variables descriptively.
58-
* Document your code thoroughly.
59-
* Make sure all the existing tests pass.
60-
* User-facing code should support the following browsers:
61-
* Chrome (Webkit-Blink / 22+)
62-
* Firefox (Gecko / 28+)
63-
* Edge (Chromium based / 12+)
64-
* Opera (Chromium-Blink / 12.1+)
65-
* Safari (Apple’s Webkit / 7+)
66-
* IE 11 (Trident)
53+
- Write comprehensive and robust tests that cover the changes you've made in your work.
54+
- Follow the appropriate code style standards for the language and framework you're using (e.g. PEP 8 for Python).
55+
- Write readable code – keep functions small and modular and name variables descriptively.
56+
- Document your code thoroughly.
57+
- Make sure all the existing tests pass.
58+
- User-facing code should support the following browsers:
59+
- Chrome (Webkit-Blink / 22+)
60+
- Firefox (Gecko / 28+)
61+
- Edge (Chromium based / 12+)
62+
- Opera (Chromium-Blink / 12.1+)
63+
- Safari (Apple’s Webkit / 7+)
64+
- IE 11 (Trident)
6765

6866

69-
<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>
67+
[^business-days]: 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.

0 commit comments

Comments
 (0)