Skip to content

Commit

Permalink
Improve contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
ihabunek committed Jan 1, 2023
1 parent 4c1f3b6 commit 02b6023
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,18 +80,6 @@ pip install -r requirements-test.txt
While the virtual env is active, running `toot` will execute the one you checked
out. This allows you to make changes and test them.

Run tests:

```
pytest
```

Check code style:

```
flake8
```

#### Crafting good commits

Please put some effort into breaking your contribution up into a series of well
Expand All @@ -114,8 +102,27 @@ Rules for commit messages:
* wrap the body at 72 characters
* use the body to explain what and why vs. how

If you use vim to write your commit messages, it will already enforce these
rules for you.
For a more detailed explanation with examples see the guide at
https://cbea.ms/git-commit/

If you use vim to write your commit messages, it will already enforce some of
these rules for you.

#### Run tests before submitting

You can run code and sytle tests by running:

```
make test
```

This runs three tools:

* `pytest` runs the test suite
* `flake8` checks code formatting
* `vermin` checks that minimum python version

Please ensure all three commands succeed before submitting your patches.

#### Submitting patches

Expand Down

0 comments on commit 02b6023

Please sign in to comment.