Skip to content

Update CONTRIBUTING.md #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SabineHaas wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

Update CONTRIBUTING.md #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5df4f0b
Update CONTRIBUTING.md
SabineHaas Apr 22, 2021
1645463
Update CONTRIBUTING.md
SabineHaas May 13, 2021
f871a30
Merge branch 'dev' into improve/release_protocol
SabineHaas May 29, 2021
60df20e
Update CHANGELOG.md
SabineHaas May 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Here is a template for new release sections
### Added
-
### Changed
-
- Improved release protocol while releasing v0.0.3 (#295)

### Removed
-
### Fixed
Expand Down
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,12 @@ Currently *pvcompare* is not released on pypi, but only on github. Please follow
Please use [semantic versioning guidelines](https://semver.org/spec/v2.0.0.html) for `X`, `Y` and `Z`.
2. In the release branch update the version number in [`__init__.py`](https://github.com/greco-project/pvcompare/blob/dev/pvcompare/__init__.py) and [`setup.py`](https://github.com/greco-project/pvcompare/blob/dev/setup.py).
3. Adapt the header `[Unreleased]` of [Changelog.md](https://github.com/greco-project/pvcompare/blob/dev/CHANGELOG.md) with the version number and the date of the release in [ISO format](https://xkcd.com/1179/): `[Version] - YYYY-MM-DD`.
4. Install pvcompare in a clean virtual environment on `release/vX.Y.Z` branch (navigate to directory where `setup.py` is located:
4. Push your changes in 2. and 3. to your release branch (commit message e.g. "Bump version number and adapt Changelog.md for release")
5. Install pvcompare in a clean virtual environment on `release/vX.Y.Z` branch (navigate to directory where `setup.py` is located):
```bash
pip install -e .[dev]
pip install -e .[dev,docs]
```
6. Run all tests locally by `EXECUTE_TESTS_ON=master pytest`.
6. Run all tests locally in this new environment (step 5) by `EXECUTE_TESTS_ON=master pytest`.
7. If there are errors, fix them in the release branch. If you fix something in the `setup.py` please test the installation in clean virtual environment again (see step 4).
8. When `EXECUTE_TESTS_ON=master pytest` passes, push your release branch, create a pull request towards `master` and merge.
9. Wait until the [build](https://github.com/greco-project/pvcompare/actions) on `master` branch passes.
Expand Down