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

docs: CONTRIBUTING.md extended.

Browse source
This commit is contained in:
Fabian Joswig 2023-03-10 14:37:50 +00:00
parent fe0f80b8c3
commit d8fb683262
No known key found for this signature in database
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.md
View file

@ -1,15 +1,18 @@
# Development # Contributing
If you are new to contributing to open source software [this guide](https://opensource.guide/how-to-contribute) can help get you started.
### Setup ### Setup
If you want to contribute to `pyerrors` please [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) `pyerrors` on Github, clone the current `develop` branch If you want to contribute to `pyerrors` please [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) `pyerrors` on Github, clone the repository
``` ```
git clone http://github.com/my_username/pyerrors.git --branch develop git clone http://github.com/my_username/pyerrors.git
``` ```
and create your own branch for the feature or bug fix and create your own branch for the feature or bug fix
``` ```
cd pyerrors cd pyerrors
git checkout -b feature/my_feature git checkout -b feature/my_feature
``` ```
Please send any pull requests to the `develop` branch. After committing your changes please send a pull requests to the `develop` branch. A guide on how to create a pull request can be found [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
### Documentation ### Documentation
Please add docstrings to any new function, class or method you implement. The documentation is automatically generated from these docstrings. We follow the [numpydoc style](https://numpydoc.readthedocs.io/en/latest/format.html) for docstrings. The startpage of the documentation is generated from the docstring of `pyerrors/__init__.py`. Please add docstrings to any new function, class or method you implement. The documentation is automatically generated from these docstrings. We follow the [numpydoc style](https://numpydoc.readthedocs.io/en/latest/format.html) for docstrings. The startpage of the documentation is generated from the docstring of `pyerrors/__init__.py`.
@ -31,4 +34,4 @@ The linter `flake8` is executed with the command
``` ```
flake8 --ignore=E501,W503 --exclude=__init__.py pyerrors flake8 --ignore=E501,W503 --exclude=__init__.py pyerrors
``` ```
Please make sure that all tests are passed for a new pull requests. Please make sure that all tests pass for a new pull requests.