Skip to content

Commit

Permalink
Better PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
urschrei committed Jan 24, 2025
1 parent 68faa2c commit d21103a
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
Thanks for opening a PR. Please read the following:
<!-- Thanks for opening a PR. Please read the following:
- **Base your changes on the `main` branch**
- If necessary, rebase against `main` before opening a pull request
- Follow [PEP 8](http://www.python.org/dev/peps/pep-0008/). I run [`ruff`](https://docs.astral.sh/ruff/) against the codebase and perhaps you should, too
- Use spaces for indentation, and ensure that all methods have a proper docstring. **Please don't use Doctest**
- This codebase uses Ruff. PRs that reformat code will not be accepted.
- Ensure that all methods added have a proper docstring. **Please do not use Doctest**
- If at all possible, don't add dependencies
- If it's unavoidable, ensure that the dependency is maintained, and supported
- If it is unavoidable, you must ensure that the dependency is maintained, and supported
- Ensure that you add your dependency to [pyproject.toml](pyproject.toml)
- Run the tests, and ensure that they pass. If you're adding a feature, **you must add tests that exercise it**
- If your pull request is a feature, **document it**
- Run the tests and ensure that they pass. If you are adding a feature **you must add tests that exercise it**
- If your pull request is a feature **document the feature**
- One feature per pull request
- If possible, [squash](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) your commits before opening a pull request, unless it makes no sense to do so
- [squash](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) your commits before opening a pull request unless it makes no sense to do so
- If in doubt, comment your code.
## License of Contributed Code
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be licensed under the Blua Oak Model License 1.0, without any additional terms or conditions.
Please note that pull requests with licenses that are more restrictive than or otherwise incompatible with the license will not be accepted.
Please note that pull requests with licenses that are more restrictive than or otherwise incompatible with the license will not be accepted. -->

Description of changes:
Issue reference (if applicable):

- [ ] I have read [the CONTRIBUTING doc](CONTRIBUTING.md)

0 comments on commit d21103a

Please sign in to comment.