Skip to content

Commit

Permalink
Mention the PR labels (and some other items) in the contribution guide (
Browse files Browse the repository at this point in the history
#220)

* Mention the PR labels (and some other items) in the contribution guide

* Rewrite one of the sentence to improve its syntax
  • Loading branch information
pnkraemer authored Sep 10, 2024
1 parent f0c9ee4 commit daf9ef1
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,14 +181,15 @@ To make a pull request, proceed as follows:
- Install all dependencies with `pip install .[full]` or `pip install -e .[full]`.
- Make your changes.
- From the project's root, run the tests via `make test`. Check out `make format-and-lint` as well. Use the pre-commit hook if you like.

- Then, make the pull request. Choose an informative title (have a look at previous PRs if you need inspiration), link all related issues, describe the change, and pick a label (e.g. "documentation", or "enhancement"). The label is important because the release notes group the pull requests by label.

When making a pull request, keep in mind the following (rough) guidelines:

* Most PRs resolve an issue.
* Most PRs contain a single commit. [Here is how we can write better commit messages](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/).
* Most enhancements (e.g. new features) are covered by tests.

[Here is what GitHub considers important for informative pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests).

## Extend Matfree's documentation

Expand Down

0 comments on commit daf9ef1

Please sign in to comment.