Skip to content

Commit c750c21

Browse files
authored
Merge pull request #181 from amadeus4dev/contributors-update
Contributor's guide update
2 parents 4af6df3 + 461b2d5 commit c750c21

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

.github/CONTRIBUTING.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,10 @@ eval "$(pyenv init -)"
1616
Second, ensure you have a version of every Python we support installed. Your versions may differ.
1717

1818
```sh
19-
pyenv install 3.4.9
20-
pyenv install 3.5.6
21-
pyenv install 3.6.3
22-
pyenv install 3.6.8
23-
pyenv global 3.6.8 3.6.3 3.5.6 3.4.9
19+
pyenv install 3.8.0
20+
pyenv install 3.9.4
21+
pyenv install 3.10.3
22+
pyenv global 3.8.0 3.9.4 3.10.3
2423
```
2524

2625
Next ensure you create a virtual environment.
@@ -39,14 +38,14 @@ To run the tests against every supported Python version, use `tox`.
3938
tox
4039
```
4140

42-
Alternatively, to run tests just against a specific Python version, create coverage files, and watch for changes:
41+
Alternatively, to run tests just against a specific Python environment run:
4342

4443
```sh
45-
brew install fswatch
46-
pyenv shell 3.6.8
47-
make watch
44+
tox -e py
4845
```
4946

47+
In order to see the code coverage results, open the `index.html` file in the `htmlcov` folder.
48+
5049
### Using a library locally
5150

5251
To install a library locally, use `pip` to install the library in editable mode.
@@ -63,7 +62,10 @@ from amadeus import Client
6362

6463
### Releasing
6564

66-
[TBD]
65+
- [ ] Update the version in `amadeus/version.py` using semver rules
66+
- [ ] Update the `CHANGELOG.rst` with the new version
67+
- [ ] Push all changes and ensure all tests pass on GitHub Actions
68+
- [ ] Draft a new [release](https://github.com/amadeus4dev/amadeus-java/releases/new) by creating a tag and copying the description from the `CHANGELOG.rst`
6769

6870
## How to contribute to the Amadeus Python SDK
6971

0 commit comments

Comments
 (0)