Skip to content

Commit 504df28

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent dacc011 commit 504df28

2 files changed

Lines changed: 22 additions & 24 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,33 @@
11
[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/)
22

3-
This is a [Jazzband](https://jazzband.co/) project.
3+
This is a [Jazzband](https://jazzband.co/) project.
44
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).
55

66
## Contributing to Django Fernet Encrypted Fields
77

8-
We welcome contributions from the community to improve and maintain Django Fernet Encrypted Fields.
8+
We welcome contributions from the community to improve and maintain Django Fernet Encrypted Fields.
99
Please follow these guidelines to ensure your contributions are accepted:
1010

1111
1. **Fork the Repository**: Start by forking the repository to a personal/organization GitHub account.
1212
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-
```
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+
```
2525
5. **Create a Branch**: Create a new branch for the feature or bug fix.
2626
6. **Make Changes**: Make the changes and ensure they are well-documented.
2727
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-
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.

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ They have the same APIs as their non-encrypted counterparts.
8181
### Compatible Django Version
8282

8383
| Compatible Django Version | Specifically tested | Python Version Required |
84-
| ------------------------- |---------------------| ----------------------- |
84+
| ------------------------- | ------------------- | ----------------------- |
8585
| `3.2` | | 3.8+ |
8686
| `4.0` | | 3.8+ |
8787
| `4.1` | | 3.8+ |
@@ -91,7 +91,6 @@ They have the same APIs as their non-encrypted counterparts.
9191
| `5.2` | :heavy_check_mark: | 3.10+ |
9292
| `6.0` | :heavy_check_mark: | 3.12+ |
9393

94-
9594
### Contributing
9695

97-
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.
96+
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.

0 commit comments

Comments
 (0)