From 1acb959093981ea7709e87067f904cf82acec301 Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Tue, 19 Oct 2021 10:34:03 +0100 Subject: [PATCH] CONTRIBUTING.md added --- CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..89a82230 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index df93c050..21a9f329 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ There exist similar implementations of gamma method error analysis suites in - [Python 3](https://github.com/mbruno46/pyobs) ## Installation -To install the current `develop` version of `pyerrors` run +To install the most recent release of `pyerrors` run ```bash pip install git+https://github.com/fjosw/pyerrors.git ```