blob: f4a165c9003e789a71d5f33896b83f5ccc6af23e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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!
|
