mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-03-15 23:00:25 +01:00
CONTRIBUTING.md updated
This commit is contained in:
parent
99357ddd97
commit
8ed1dac057
1 changed files with 6 additions and 5 deletions
|
@ -1,26 +1,27 @@
|
|||
# Development
|
||||
### 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
|
||||
```
|
||||
cd pyerrors
|
||||
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 .
|
||||
```
|
||||
Please send any pull requests to the `develop` branch.
|
||||
### 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
|
||||
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
|
||||
For all pull requests tests are executed for the most recent python releases via
|
||||
```
|
||||
pytest -v
|
||||
```
|
||||
|
|
Loading…
Add table
Reference in a new issue