Skip to content

Commit e99857e

Browse files
committed
Clean up contributing section
1 parent bb5dee4 commit e99857e

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Developers Guide
22

3+
## Setup
4+
5+
Create a new virtual environment to test the code (recommended):
6+
```
7+
python3 -m venv .venv
8+
. .venv/bin/activate
9+
```
10+
311
To install dependencies for development:
412
```
513
pip install -r requirements.txt
@@ -17,9 +25,6 @@ sphinx-build -b html . htmldir
1725

1826
The tests use a locally built and installed module for this code:
1927
```
20-
# Create a new virtual environment to test the code
21-
python3 -m venv .venv
22-
. .venv/bin/activate
2328
# Build current code and install package
2429
pip install --editable .
2530
```
@@ -40,16 +45,6 @@ Then run the tests:
4045
python3 tests/test.py
4146
```
4247

43-
Once you are done testing:
44-
```
45-
# Stop an delete the server
46-
docker container stop aerospike
47-
docker container rm aerospike
48-
# Quit and delete virtual environment
49-
deactivate
50-
rm -r .venv
51-
```
52-
5348
## Codestyle
5449

5550
This code uses [flake8](https://github.com/pycqa/flake8) for codestyle checking.
@@ -62,4 +57,18 @@ flake8 . --count --max-complexity=10 --show-source --max-line-length=127
6257

6358
## Adding features
6459

65-
This project depends on a [fork](https://github.com/aerospike-community/jsonpath-ng) (i.e custom version) of the jsonpath-ng library. To add features, you may have to create a pull request in the fork as well as in this repository. Then, the project will use the latest commit of the forked library in the following release.
60+
This project depends on a [fork](https://github.com/aerospike-community/jsonpath-ng) (i.e custom version) of the jsonpath-ng library. To add features:
61+
1. Create a pull request in the fork with your proposed changes. Once the changes are approved, a new version of the library will be published to PyPI.
62+
2. Create another pull request in this repository to point to the updated version of the library. The next release of this library will use the new library version.
63+
64+
## Cleanup
65+
66+
```
67+
# Stop an delete the server
68+
docker container stop aerospike
69+
docker container rm aerospike
70+
71+
# Quit and delete virtual environment
72+
deactivate
73+
rm -r .venv
74+
```

0 commit comments

Comments
 (0)