Skip to content

Commit

Permalink
Update justfile and documentation for contributors (#579)
Browse files Browse the repository at this point in the history
  • Loading branch information
dyve authored Dec 9, 2024
1 parent 20c2610 commit 4324d80
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,29 +47,28 @@ You will need some knowledge of git, github, and Python/Django development. Usin

### Local installation

This section assumes you know about local Python versions and virtual environments.
This pages uses [uv](https://github.com/astral-sh/uv) and [just](https://github.com/casey/just).

To clone the repository and install the requirements for local development:
After installing both, check out this repository and type `just bootstrap` to bootstrap a development environment.

```console
git clone git://github.com/zostera/django-marina.git
cd django-marina
pip install -U pip -r requirements-dev.txt
pip install -e .
just bootstrap
```

### Running the tests

To run the tests:

```console
make test
just test
```

To run the tests on all supported Python/Django combinations:

```console
make tests
just tests
```

## Pull Request Guidelines
Expand Down
4 changes: 4 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ default:
coverage run manage.py test
coverage report

# Test
@tests: bootstrap
tox

# Build
@build: bootstrap
uv build
Expand Down

0 comments on commit 4324d80

Please # to comment.