From bb3477cd693d1c8e77e75e61a1a7e1a4647e6a3c Mon Sep 17 00:00:00 2001 From: euronion <42553970+euronion@users.noreply.github.com> Date: Tue, 14 Apr 2020 10:54:39 +0200 Subject: [PATCH] Add information on PRs to contribution guidelines. (#151) --- doc/contributing.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/contributing.rst b/doc/contributing.rst index 1d98e64f..7f30dea0 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -2,10 +2,18 @@ Contributing ####################### -We strongly welcome anyone interested in contributing to this project, -be it with new ideas, suggestions, by filing bug reports or contributing code. +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 `_. -You are invited to submit pull requests and file issues to the `GitHub repository `_. +* 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 `_ 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. If you are unfamiliar with pull requests, the GitHub help pages have a nice `guide `_.