2019-06-07 08:34:36 +00:00
|
|
|
#######################
|
|
|
|
|
Contributing
|
|
|
|
|
#######################
|
|
|
|
|
|
2020-04-14 08:54:39 +00:00
|
|
|
We happily welcome anyone interested in contributing to this project,
|
|
|
|
|
be it with new ideas, suggestions, by filing bug reports or contributing code
|
|
|
|
|
to our `GitHub repository <https://github.com/PyPSA/PyPSA-Eur>`_.
|
2019-06-07 08:34:36 +00:00
|
|
|
|
2020-04-14 08:54:39 +00:00
|
|
|
* If you already have some code changes, you can submit them directly as a pull request.
|
|
|
|
|
* If you start working on a feature in the code, let us know by opening an issue or a draft pull request.
|
|
|
|
|
This helps all of us to keep an overview on what is being done and helps to avoid a situation where we
|
|
|
|
|
are doing the same work twice in parallel.
|
|
|
|
|
* We encourage you to use the `PEP 8 coding style <https://www.python.org/dev/peps/pep-0008/>`_ in your code.
|
|
|
|
|
|
|
|
|
|
For all code contributions we follow the four eyes principle (two person principle), i.e. all suggested code
|
|
|
|
|
including our own are reviewed by a second person before they are incoporated into our repository.
|
2019-06-07 08:34:36 +00:00
|
|
|
|
2020-01-09 13:09:28 +00:00
|
|
|
If you are unfamiliar with pull requests, the GitHub help pages have a nice `guide <https://help.github.com/en/articles/about-pull-requests>`_.
|
|
|
|
|
|
|
|
|
|
To ask and answer general usage questions, join the `PyPSA and PyPSA-Eur mailing list <https://groups.google.com/forum/#!forum/pypsa>`_.
|
