Skip to content

Commit dacc011

Browse files
committed
add contributing readme
1 parent f005bc8 commit dacc011

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/)
2+
3+
This is a [Jazzband](https://jazzband.co/) project.
4+
By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct) and follow the [guidelines](https://jazzband.co/about/guidelines).
5+
6+
## Contributing to Django Fernet Encrypted Fields
7+
8+
We welcome contributions from the community to improve and maintain Django Fernet Encrypted Fields.
9+
Please follow these guidelines to ensure your contributions are accepted:
10+
11+
1. **Fork the Repository**: Start by forking the repository to a personal/organization GitHub account.
12+
2. **Clone the Repository**: Clone the forked repository to your local machine.
13+
3. **Set Up the Environment**: Set up a virtual environment and install the necessary
14+
dependencies for development and testing.
15+
```shell
16+
$ python -m venv .venv
17+
$ source .venv/bin/activate
18+
$ pip install -r requirements.txt
19+
```
20+
4. **Install the pre-commit hooks**: We use [pre-commit](https://pre-commit.com/) to ensure code quality.
21+
Install the pre-commit hooks by running:
22+
```shell
23+
$ pre-commit install
24+
```
25+
5. **Create a Branch**: Create a new branch for the feature or bug fix.
26+
6. **Make Changes**: Make the changes and ensure they are well-documented.
27+
7. **Run Tests**: Ensure all tests pass before submitting a pull request.
28+
```shell
29+
$ pip install coverage pytest
30+
$ coverage3 run --source='./encrypted_fields' manage.py test
31+
```
32+
8. **Submit Pull Request**: Submit a pull request with a clear title, description of the changes,
33+
motivations, and any relevant issue numbers.
34+

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,8 @@ They have the same APIs as their non-encrypted counterparts.
9090
| `5.1` | :heavy_check_mark: | 3.10+ |
9191
| `5.2` | :heavy_check_mark: | 3.10+ |
9292
| `6.0` | :heavy_check_mark: | 3.12+ |
93+
94+
95+
### Contributing
96+
97+
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.

0 commit comments

Comments
 (0)