Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add missing namespaces to contributing page #8239

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+7 −7
Open

Add missing namespaces to contributing page #8239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/docs/develop/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To setup a development environment using [docker](../start/docker.md), run the f
```bash
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 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
```

Expand All @@ -34,8 +34,8 @@ A "bare metal" development setup can be installed as follows:
```bash
git clone https://github.com/inventree/InvenTree.git && cd InvenTree
python3 -m venv env && source env/bin/activate
pip install invoke && invoke
pip install invoke && invoke setup-dev --tests
pip install django invoke && invoke
invoke dev.setup-dev --tests
```

Read the [InvenTree setup documentation](../start/intro.md) for a complete installation reference guide.
Expand All @@ -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.

```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.*
Expand Down Expand Up @@ -170,18 +170,18 @@ The various github actions can be found in the `./github/workflows` directory

To run test locally, use:
```
invoke test
invoke dev.test
```

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:

```
invoke test --help
invoke dev.test --help
```

## Code Style
Expand Down
Loading