inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-12 18:15:40 +00:00
Code Activity

Development improvements (#3413)

Browse Source 
* rename .env to make sure it is not loaded by default

* make sure migrations are run before import

* Add more messaget to setup_test

* add comments to setup-dev

* Add flag to setup-dev for setting up test data

* add flag to setup-test to also run development setup

* extend contributing with the flags

* change flag to tests

* Add option helptexts

* A nicer starter

* add 3 liner

* Revert "rename .env to make sure it is not loaded by default"

This reverts commit 95fa0bbc53.
This commit is contained in:
Matthias Mair
2022-07-29 06:58:54 +02:00
committed by GitHub
parent 4d5e267753
commit e461a2c1ef
2 changed files with 44 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -1,8 +1,27 @@
Hi there, thank you for your intrest in contributing!
Please read the contribution guidelines below, before submitting your first pull request to the InvenTree codebase.
Up an running in 3 LOC:
```bash
git clone https://github.com/inventree/InvenTree.git && cd InvenTree
python3 -m venv env && source env/bin/activate
pip install invoke && invoke setup-dev --tests
```
## 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.
Run the following command to set up all toolsets for development.
```bash
invoke setup-dev
```
With the flag `tests` the database will additionally be populated with the [offical](https://github.com/inventree/demo-dataset) test dataset.
```bash
invoke setup-dev --tests
```
Run either command 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