From f840f8d2a53bd558e7cea41115c81d76a045312e Mon Sep 17 00:00:00 2001 From: John Speed Meyers Date: Fri, 29 Dec 2023 05:51:31 -0500 Subject: [PATCH] Add pylint and black formatting instructions to contributing doc Signed-off-by: John Speed Meyers --- CONTRIBUTING.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d094eb..742518a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,17 +47,18 @@ Here's the process to make changes to the codebase: python setup.py test # in the repo root ``` You may use other test runners, such as `pytest` or `nose` at your preference. -6. Push the branch to your fork on GitHub: +6. Format your changes with [`black`](https://github.com/psf/black) and [`pylint`](https://github.com/pylint-dev/pylint). +7. Push the branch to your fork on GitHub: ```sh git push origin fix-or-improve-something ``` -7. Make a pull request on GitHub. -8. Continue making more changes and commits on the branch, with `git commit --signoff` and `git push`. -9. When done, write a comment on the PR asking for a code review. -10. Some other developer will review your changes and accept your PR. The merge should be done with `rebase`, if +8. Make a pull request on GitHub. +9. Continue making more changes and commits on the branch, with `git commit --signoff` and `git push`. +10. When done, write a comment on the PR asking for a code review. +11. Some other developer will review your changes and accept your PR. The merge should be done with `rebase`, if possible, or with `squash`. -11. The temporary branch on GitHub should be deleted (there is a button for deleting it). -12. Delete the local branch as well: +12. The temporary branch on GitHub should be deleted (there is a button for deleting it). +13. Delete the local branch as well: ```sh git checkout master git pull -p