Skip to content

Commit

Permalink
properly format the PR checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
romainmartinez committed Jun 3, 2020
1 parent 2a66904 commit 4c77645
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/contributing.md
Expand Up @@ -73,11 +73,16 @@ This request then goes to the repository maintainers, and they will review the c
If you need to make more changes, you can make them in your branch, add them to a new commit and push them to GitHub.
The pull request will be automatically updated.

!!! note "PR Checklist"
!!! info "PR Checklist"

Let's summarize the steps needed to get your PR ready for submission.
0. **Use an isolated Python environment**.
1. **Properly test your code**. Write new tests if needed and make sure that your modification didn't break anything by running `make test`.
2. **Properly format your code**. You can verify that it passes the formatting guidelines by running `make lint`.
3. **Push your code and create a PR**.
4. **Properly describe your modifications** with a helpful title and description. If this addresses an issue, please reference it.

1. **Use an isolated Python environment**.

2. **Properly test your code**. Write new tests if needed and make sure that your modification didn't break anything by running `make test`.

3. **Properly format your code**. You can verify that it passes the formatting guidelines by running `make lint`.

4. **Push your code and create a PR**.

5. **Properly describe your modifications** with a helpful title and description. If this addresses an issue, please reference it.

0 comments on commit 4c77645

Please sign in to comment.