From 504df2835b9520015dde4a1e368d86f8312aff63 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 7 Mar 2026 21:56:46 +0000 Subject: [PATCH] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 41 ++++++++++++++++++++--------------------- README.md | 5 ++--- 2 files changed, 22 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09968ec..e2c9c3a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 9747183..ff1f2f0 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.