Skip to content

Commit

Permalink
docs: add contributing guide to README.md
Browse files Browse the repository at this point in the history
Add contributing guide to README.md based upon the suggestion of
@arjentz in #41.

Signed-off-by: Roald Nefs <info@roaldnefs.com>
Co-authored-by: Arjentz <4867268+arjentz@users.noreply.github.com>
  • Loading branch information
roaldnefs and atezet committed Dec 27, 2022
1 parent 9dd1ce4 commit 30cf70e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,29 @@ class NaClIPAddressField(NaClFieldMixin, models.IPAddressField):

Please report any issues you encounter when trying this.

## Contributing

Start a PostgreSQL Docker container for testing using:
```bash
docker run --rm -e POSTGRES_PASSWORD=postgres POSTGRES_DB=github_actions postgres
```

Then, you can run tests in another window using:
```bash
python -m venv env
source env/bin/activate
pip install '.[test]'
python manage.py test
```

Before you contribute, make sure you lint your code:
```bash
pip install '.[lint]'
flake8 --exclude .git,pycache,docs/conf.py,build,dist,env
```

After you code is done, free free to open a new pull request.

## References

- <https://github.com/defrex/django-encrypted-fields>
Expand Down

0 comments on commit 30cf70e

Please sign in to comment.