🎉 Thanks for taking the time to contribute! 🎉
The following is a set of guidelines for contributing to ormar-postgres-extenions.
These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document.
What should I know before I get started?
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.
- Python typing and hints: typing
- Semantic versioning: semver
Before diving into writing code, please take a look at the following.
When attempting to fix a bug, create an issue using the "Bug report" template.
Give as much information in this issue as it allows for discussions and documentation about the decisions reached for any bugs that have been encounted.
Have an idea? Create an issue using the "Feature request" template.
Detailing in there as much as possible, the idea and any potential solutions to it, before suggesting a pull request.
Have an issue to submit code changes for? See below.
- Clone the repository
- Run
. script/bootstrapto ensure you're working from the correct environment - Run
inv testto verify enviroment is correctly setup - Checkout a new branch and add code changes
- Add tests to verify code changes and rerun
inv test - See submitting pull requests
Creating a pull request uses our template using the GitHub web interface.
Fill in the relevant sections, clearly linking the issue the change is attemping to resolve.
A linter is available to catch most of our styling concerns. This is provided in a pre-commit hook when setting up local development.
You can also run inv lint --fix to see and solve what issues it can.
Please tag issues and pull requests according to the relevant github labels.