Hopiu/django-fernet-encrypted-fields
1
0
Fork 0
mirror of https://github.com/jazzband/django-fernet-encrypted-fields.git synced 2026-03-16 22:40:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

[pre-commit.ci] auto fixes from pre-commit.com hooks

Browse source 
for more information, see https://pre-commit.ci
This commit is contained in:
pre-commit-ci[bot] 2026-03-07 21:56:46 +00:00
parent dacc011fae
commit 504df2835b
2 changed files with 22 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
CONTRIBUTING.md
View file

@ -1,34 +1,33 @@
[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/)
This is a [Jazzband](https://jazzband.co/) project.
This is a [Jazzband](https://jazzband.co/) project.
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).
## Contributing to Django Fernet Encrypted Fields
We welcome contributions from the community to improve and maintain Django Fernet Encrypted Fields.
We welcome contributions from the community to improve and maintain Django Fernet Encrypted Fields.
Please follow these guidelines to ensure your contributions are accepted:
1. **Fork the Repository**: Start by forking the repository to a personal/organization GitHub account.
2. **Clone the Repository**: Clone the forked repository to your local machine.
3. **Set Up the Environment**: Set up a virtual environment and install the necessary
dependencies for development and testing.
```shell
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
```
4. **Install the pre-commit hooks**: We use [pre-commit](https://pre-commit.com/) to ensure code quality.
Install the pre-commit hooks by running:
```shell
$ pre-commit install
```
3. **Set Up the Environment**: Set up a virtual environment and install the necessary
dependencies for development and testing.
```shell
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
```
4. **Install the pre-commit hooks**: We use [pre-commit](https://pre-commit.com/) to ensure code quality.
Install the pre-commit hooks by running:
```shell
$ pre-commit install
```
5. **Create a Branch**: Create a new branch for the feature or bug fix.
6. **Make Changes**: Make the changes and ensure they are well-documented.
7. **Run Tests**: Ensure all tests pass before submitting a pull request.
```shell
$ pip install coverage pytest
$ coverage3 run --source='./encrypted_fields' manage.py test
```
8. **Submit Pull Request**: Submit a pull request with a clear title, description of the changes,
motivations, and any relevant issue numbers.
```shell
$ pip install coverage pytest
$ coverage3 run --source='./encrypted_fields' manage.py test
```
8. **Submit Pull Request**: Submit a pull request with a clear title, description of the changes,
motivations, and any relevant issue numbers.

5
README.md
View file

@ -81,7 +81,7 @@ They have the same APIs as their non-encrypted counterparts.
### Compatible Django Version
| Compatible Django Version | Specifically tested | Python Version Required |
| ------------------------- |---------------------| ----------------------- |
| ------------------------- | ------------------- | ----------------------- |
| `3.2` | | 3.8+ |
| `4.0` | | 3.8+ |
| `4.1` | | 3.8+ |
@ -91,7 +91,6 @@ They have the same APIs as their non-encrypted counterparts.
| `5.2` | :heavy_check_mark: | 3.10+ |
| `6.0` | :heavy_check_mark: | 3.12+ |
### Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.