Skip to content

Commit 91eb652

Browse files
committed
updates to contributing
1 parent 42b9e57 commit 91eb652

File tree

1 file changed

+46
-38
lines changed

1 file changed

+46
-38
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ We provide a platform independent justfile with recipes for all the development
2020
Next, initialize and install the development environment:
2121

2222
```bash
23-
just setup
23+
just setup <optional python version>
2424
just install
2525
```
2626

@@ -33,6 +33,12 @@ Next, initialize and install the development environment:
3333
just docs
3434
```
3535

36+
You can run a live documentation server that will automatically update during editing using:
37+
38+
```bash
39+
just docs-live
40+
```
41+
3642
## Static Analysis
3743

3844
`django-enum` uses [ruff](https://docs.astral.sh/ruff) for python linting and formatting. [mypy](http://mypy-lang.org) is used for static type checking. Before any PR is accepted the following must be run, and static analysis tools should not produce any errors or warnings. Disabling certain errors or warnings where justified is acceptable:
@@ -98,41 +104,43 @@ The release workflow is triggered by tag creation. You must have [git tag signin
98104
## Just Recipes
99105

100106
```
101-
build # build docs and package
102-
build-docs # build the docs
103-
build-docs-html # build html documentation
104-
build-docs-pdf # build pdf documentation
105-
check # run all static checks
106-
check-docs # lint the documentation
107-
check-docs-links # check the documentation links for broken links
108-
check-format # check if the code needs formatting
109-
check-lint # lint the code
110-
check-package # run package checks
111-
check-readme # check that the readme renders
112-
check-types # run static type checking
113-
clean # remove all non repository artifacts
114-
clean-docs # remove doc build artifacts
115-
clean-env # remove the virtual environment
116-
clean-git-ignored # remove all git ignored files
117-
coverage # generate the test coverage report
118-
docs # build and open the documentation
119-
docs-live # serve the documentation, with auto-reload
120-
fix # fix formatting, linting issues and import sorting
121-
format # format the code and sort imports
122-
install *OPTS # update and install development dependencies
123-
install-docs # install documentation dependencies
124-
install-precommit # install git pre-commit hooks
125-
install_uv # install the uv package manager
126-
lint # sort the imports and fix linting issues
127-
manage *COMMAND # run the django admin
128-
open-docs # open the html documentation
129-
precommit # run the pre-commit checks
130-
release VERSION # issue a relase for the given semver string (e.g. 2.1.0)
131-
run +ARGS # run the command in the virtual environment
132-
setup python="python" # setup the venv and pre-commit hooks
133-
sort-imports # sort the python imports
134-
test *TESTS # run tests
135-
test-all DB_CLIENT="dev" # run all tests
136-
test-lock +PACKAGES # lock to specific python and versions of given dependencies
137-
validate_version VERSION # validate the given version string against the lib version
107+
build # build docs and package
108+
build-docs # build the docs
109+
build-docs-html # build html documentation
110+
build-docs-pdf # build pdf documentation
111+
check # run all static checks
112+
check-docs # lint the documentation
113+
check-docs-links # check the documentation links for broken links
114+
check-format # check if the code needs formatting
115+
check-lint # lint the code
116+
check-package # run package checks
117+
check-readme # check that the readme renders
118+
check-types # run static type checking
119+
clean # remove all non repository artifacts
120+
clean-docs # remove doc build artifacts
121+
clean-env # remove the virtual environment
122+
clean-git-ignored # remove all git ignored files
123+
coverage # generate the test coverage report
124+
docs # build and open the documentation
125+
docs-live # serve the documentation, with auto-reload
126+
fetch-refs LIB # fetch the intersphinx references for the given package
127+
fix # fix formatting, linting issues and import sorting
128+
format # format the code and sort imports
129+
install *OPTS="--all-extras" # update and install development dependencies
130+
install-docs # install documentation dependencies
131+
install-precommit # install git pre-commit hooks
132+
install_uv # install the uv package manager
133+
lint # sort the imports and fix linting issues
134+
manage *COMMAND # run the django admin
135+
open-docs # open the html documentation
136+
precommit # run the pre-commit checks
137+
release VERSION # issue a relase for the given semver string (e.g. 2.1.0)
138+
run +ARGS # run the command in the virtual environment
139+
runserver # run the development server
140+
setup python="python" # setup the venv, pre-commit hooks and playwright dependencies
141+
sort-imports # sort the python imports
142+
test *TESTS # run tests
143+
test-all DB_CLIENT="dev" # run all tests
144+
test-lock +PACKAGES # lock to specific python and versions of given dependencies
145+
validate_version VERSION # validate the given version string against the lib version
138146
```

0 commit comments

Comments
 (0)