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

chore: update contributing guide #524

Open
wants to merge 1 commit into
base: v3
Choose a base branch
from
Open

chore: update contributing guide #524

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
16 changes: 15 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,21 @@ please consider submitting them as separate pull requests unless they are relate

Here are a few tips to increase the likelihood of being merged:

- [ ] Write tests.
- [ ] Write tests & run them
```sh
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install tox
$ tox -e py{PYTHON_VERSION}-{sync|async}
```
- [ ] Check types
```sh
$ tox -e types
```
- [ ] Check format
```sh
$ tox -e format
```
- [ ] Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
- [ ] Allow [edits from maintainers](https://blog.github.com/2016-09-07-improving-collaboration-with-forks/).

Expand Down