CONTRIBUTING.md added

This commit is contained in:
Fabian Joswig 2021-10-19 10:34:03 +01:00
parent 3d8887cd65
commit 1acb959093
2 changed files with 32 additions and 1 deletions

31
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,31 @@
# Development
### Setup
If you want to contribute to `pyerrors` please clone the current `develop` branch
```
git clone http://github.com/fjosw/pyerrors.git --branch develop
```
and create your own branch
```
cd pyerrors
git checkout -b feature/my_feature
```
I find it convenient to install the package in editable mode in your local python environment
```
pip install -e .
```
### Documentation
Please add meaningful docstrings to any new function, class or method you implement.
### Tests
When implementing a new feature or fixing a bug please add meaningful tests to the files in the `tests` directory which cover the new code.
### Continous integration
For all pull requests to the `develop` branch tests are executed for the most recent python releases via
```
pytest -v
```
and `flake8` is executed with the command
```
flake8 --ignore=E501,E722 --exclude=__init__.py pyerrors
```
Please make sure that all tests are passed for a new pull request.

View file

@ -14,7 +14,7 @@ There exist similar implementations of gamma method error analysis suites in
- [Python 3](https://github.com/mbruno46/pyobs) - [Python 3](https://github.com/mbruno46/pyobs)
## Installation ## Installation
To install the current `develop` version of `pyerrors` run To install the most recent release of `pyerrors` run
```bash ```bash
pip install git+https://github.com/fjosw/pyerrors.git pip install git+https://github.com/fjosw/pyerrors.git
``` ```