|
8 | 8 |
|
9 | 9 | We ask that contributors to CC projects submit a pull request with your changes. If you're not familiar with pull requests, please read [this GitHub documentation](https://help.github.com/en/articles/about-pull-requests). Here are our expectations for pull requests; following them will expedite the process of merging your code in.
|
10 | 10 |
|
11 |
| -* 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). |
12 |
| -* **Make a Branch** |
| 11 | +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). |
| 12 | + |
| 13 | +* **Make A Branch** |
13 | 14 | * 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.
|
14 |
| -* **Push your code ASAP** |
| 15 | +* **Push Your Code ASAP** |
15 | 16 | * Push your code as soon as you can. Follow the "[early and often](https://www.worklytics.co/blog/commit-early-push-often/)" rule.
|
16 |
| - * 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). |
| 17 | + * 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). |
| 18 | + <br/> |
| 19 | + [Screenshot: How to create draft PR?](draft_pr.gif) |
17 | 20 | * **Describe Your Pull Request**
|
18 |
| - * Use the format specified in pull request template for the repository. |
| 21 | + * Use the format specified in pull request template for the repository. **Populate the stencil completely** for maximum verbosity. |
| 22 | + * Tag the actual issue number by replacing `#[issue_number]` e.g. `#42`. |
| 23 | + This closes the issue when your PR is merged. |
| 24 | + * Tag the actual issue author by replace `@[author]` e.g. `@issue_author`. |
| 25 | + This brings the reporter of the issue into the conversation. |
| 26 | + * Mark the tasks off your checklist by adding an `x` in the `[ ]` e.g. `[x]`. |
| 27 | + This checks off the boxes in your to-do list. The more boxes you check, the better. |
19 | 28 | * Describe your change in detail. Too much detail is better than too little.
|
20 | 29 | * Describe how you tested your change.
|
| 30 | + * 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. |
| 31 | + <br/> |
| 32 | + [Screenshot: Populated pull request](populated_pr.png) |
21 | 33 | * **Request Review**
|
22 |
| - * Once your PR is ready, remove the "[WIP]" from the title and/or change it from a draft PR to a regular PR. |
| 34 | + * Once your PR is ready, **remove the "[WIP]" from the title** and/or change it from a draft PR to a regular PR. |
23 | 35 | * 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.
|
| 36 | +* **Incorporating feedback** |
| 37 | + * 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. |
24 | 38 | * Be sure to **re-request review** once you have made changes after a code review.
|
| 39 | + <br/> |
| 40 | + [Screenshot: How to request re-review?](rereview.png) |
| 41 | + * 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. |
| 42 | + <br/> |
| 43 | + [Screenshot: Difference between 'Changes requested' and 'Review required'](difference.png) |
| 44 | + |
25 | 45 |
|
26 | 46 | ## Code guidelines
|
27 | 47 |
|
|
0 commit comments