Add pre-commit comment

This commit is contained in:
Matthias Mair 2022-05-19 01:34:39 +02:00 committed by GitHub
parent 3fd5761089
commit f98ec6cf35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,5 +1,9 @@
Please read the contribution guidelines below, before submitting your first pull request to the InvenTree codebase.
## Setup
Please run `invoke setup_dev` in the root directory of your InvenTree code base to set up your development setup before starting to contribute. This will install and set up pre-commit to run some checks before each commit and help reduce the style errors.
## Branches and Versioning
InvenTree roughly follow the [GitLab flow](https://docs.gitlab.com/ee/topics/gitlab_flow.html) branching style, to allow simple management of multiple tagged releases, short-lived branches, and development on the main branch.