Skip to content

Commit

Permalink
update CONTRIBUTING.md: Add link to installation of Anaconda environm…
Browse files Browse the repository at this point in the history
…ent & move
  • Loading branch information
treee111 committed Jan 19, 2022
1 parent 8ee2290 commit 0136e5e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,14 @@ After testing carefully, changes are merged into main and a Release will be crea

### Automatic CHANGELOG creation
After installing [git-chglog](https://github.com/git-chglog/git-chglog) locally, the CHANGELOG.md can be generated with this command:
`git-chglog -o CHANGELOG.md`
```
git-chglog -o CHANGELOG.md
```

To generate the CHANGELOG.md for a upcoming release (no tag exists yet), the following command can be used:
`git-chglog -o CHANGELOG.md --next-tag v0.10.0`
```
git-chglog -o CHANGELOG.md --next-tag v0.10.0
```

## Structure of the repository
There is one python coding base for both Windows and for macOS.
Expand All @@ -91,4 +95,6 @@ and the .yml files with the dependencies via
conda env export > environment.yml
```

The installation of Anaconda envirionments is described [here](docs/QUICKSTART_ANACONDA.md)

more information on [documentation for sharing anaconda environments](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#exporting-an-environment-file-across-platforms)

0 comments on commit 0136e5e

Please sign in to comment.