inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-05-01 21:16:46 +00:00
Code

Add missing namespaces to contributing page (#8239)

Browse Source
This commit is contained in:
Joe Rogers 2024-10-05 16:59:10 -04:00 committed by GitHub
parent f8c7635a8d
commit 7e7cfb8ee1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/develop/contributing.md
View File

@ -23,7 +23,7 @@ To setup a development environment using [docker](../start/docker.md), run the f
```bash ```bash
git clone https://github.com/inventree/InvenTree.git && cd InvenTree git clone https://github.com/inventree/InvenTree.git && cd InvenTree
docker compose --project-directory . -f contrib/container/dev-docker-compose.yml run --rm inventree-dev-server invoke install docker compose --project-directory . -f contrib/container/dev-docker-compose.yml run --rm inventree-dev-server invoke install
docker compose --project-directory . -f contrib/container/dev-docker-compose.yml run --rm inventree-dev-server invoke setup-test --dev docker compose --project-directory . -f contrib/container/dev-docker-compose.yml run --rm inventree-dev-server invoke dev.setup-test --dev
docker compose --project-directory . -f contrib/container/dev-docker-compose.yml up -d docker compose --project-directory . -f contrib/container/dev-docker-compose.yml up -d
``` ```
@ -34,8 +34,8 @@ A "bare metal" development setup can be installed as follows:
```bash ```bash
git clone https://github.com/inventree/InvenTree.git && cd InvenTree git clone https://github.com/inventree/InvenTree.git && cd InvenTree
python3 -m venv env && source env/bin/activate python3 -m venv env && source env/bin/activate
pip install invoke && invoke pip install django invoke && invoke
pip install invoke && invoke setup-dev --tests invoke dev.setup-dev --tests
``` ```
Read the [InvenTree setup documentation](../start/intro.md) for a complete installation reference guide. Read the [InvenTree setup documentation](../start/intro.md) for a complete installation reference guide.
@ -45,7 +45,7 @@ Read the [InvenTree setup documentation](../start/intro.md) for a complete insta
Run the following command to set up all toolsets for development. Run the following command to set up all toolsets for development.
```bash ```bash
invoke setup-dev invoke dev.setup-dev
``` ```
*We recommend you run this command before starting to contribute. This will install and set up `pre-commit` to run some checks before each commit and help reduce errors.* *We recommend you run this command before starting to contribute. This will install and set up `pre-commit` to run some checks before each commit and help reduce errors.*
@ -170,18 +170,18 @@ The various github actions can be found in the `./github/workflows` directory
To run test locally, use: To run test locally, use:
``` ```
invoke test invoke dev.test
``` ```
To run only partial tests, for example for a module use: To run only partial tests, for example for a module use:
``` ```
invoke test --runtest order invoke dev.test --runtest order
``` ```
To see all the available options: To see all the available options:
``` ```
invoke test --help invoke dev.test --help
``` ```
## Code Style ## Code Style