Skip to content

Commit 229dfd2

Browse files
committed
docs(contributing): update PR guidelines
1 parent 1370a7a commit 229dfd2

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

CONTRIBUTING.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ To send us a pull request, please:
3131

3232
1. Fork the repository.
3333
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34-
3. Ensure local tests pass.
35-
4. Commit to your fork using clear commit messages.
36-
5. Send us a pull request, answering any default questions in the pull request interface.
37-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
34+
3. Pre-commit hooks have been run.
35+
4. Ensure unit tests are passing by running `pytest test/unit`
36+
5. Commit to your fork using clear commit messages that follow [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) specification.
37+
6. Send us a pull request, answering any default questions in the pull request interface.
38+
7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
3839

3940
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4041
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

0 commit comments

Comments
 (0)