lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-05-14 19:43:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

CONTRIBUTING.md updated

Browse source
This commit is contained in:
Fabian Joswig 2021-10-21 15:05:21 +01:00
parent 99357ddd97
commit 8ed1dac057
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -1,26 +1,27 @@
# Development # Development
### Setup ### Setup
If you want to contribute to `pyerrors` please clone the current `develop` branch If you want to contribute to `pyerrors` please fork `pyerrors` on Github, clone the current `develop` branch
``` ```
git clone http://github.com/fjosw/pyerrors.git --branch develop git clone http://github.com/my_username/pyerrors.git --branch develop
``` ```
and create your own branch and create your own branch
``` ```
cd pyerrors cd pyerrors
git checkout -b feature/my_feature git checkout -b feature/my_feature
``` ```
I find it convenient to install the package in editable mode in your local python environment I find it convenient to install the package in editable mode in the local python environment
``` ```
pip install -e . pip install -e .
``` ```
Please send any pull requests to the `develop` branch.
### Documentation ### Documentation
Please add meaningful docstrings to any new function, class or method you implement. Please add docstrings to any new function, class or method you implement.
### Tests ### 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. 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 ### Continous integration
For all pull requests to the `develop` branch tests are executed for the most recent python releases via For all pull requests tests are executed for the most recent python releases via
``` ```
pytest -v pytest -v
``` ```