diff options
Diffstat (limited to 'docs/contributor/contributing.rst')
| -rw-r--r-- | docs/contributor/contributing.rst | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/contributor/contributing.rst b/docs/contributor/contributing.rst new file mode 100644 index 0000000..f4a165c --- /dev/null +++ b/docs/contributor/contributing.rst @@ -0,0 +1,50 @@ +.. _code-contribution-guide: + +============================ +So You Want to Contribute... +============================ + +This document provides some necessary points for developers to consider when +writing and reviewing python-gitlab code. The checklist will help developers get +things right. + +Getting Started +=============== + +If you're completely new to GitHub development and want to contribute to the +python-gitlab project, please start by familiarizing yourself with the `GitHub +Getting Started Guide <https://docs.github.com/en/get-started>`_. This will +help you familiarize yourself with the workflow for the GitHub continuous +integration and testing systems, and help you with your first commit. + +Useful Links +------------ + +Bug/Task tracker + https://github.com/python-gitlab/python-gitlab/issues + +Code Hosting + https://github.com/python-gitlab/python-gitlab + +Getting Your Patch Merged +------------------------- + +TODO: Document info that will be useful + +Bug Reporting +============= + +Bugs can reported via our issue tracker at +https://github.com/python-gitlab/python-gitlab/issues + +When filing bugs, please include as much detail as possible, and don't be shy. + +Essential pieces of information are generally: + +* Steps to reproduce the issue. +* Exceptions and surrounding lines from the logs. +* Versions of python-gitlab and Gitlab. + +Please also set your expectations of what *should* be happening. +Statements of user expectations are how we understand what is occuring and +how we learn new use cases! |