Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pylint and black formatting instructions to contributing doc #171

Merged
merged 1 commit into from
Dec 29, 2023
Merged

Add pylint and black formatting instructions to contributing doc #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading