CONTRIBUTING.rst 2.16 KB
Newer Older
1 2 3
How to contribute to DebOps
===========================

4
This file explains how you can contribute to the DebOps project.
5 6


7 8
Code contributions
------------------
9

10 11
Pull requests welcome
~~~~~~~~~~~~~~~~~~~~~
12

13 14 15 16
DebOps is primarly developed using GitHub pull requests. After forking the main
project repository to your own GitHub account, you should create a branch for
a new feature or a bugfix; this helps separate your work on different parts of
the repository. You can read the `DEVELOPMENT.rst <https://github.com/debops/debops/blob/master/DEVELOPMENT.rst>`__
Lee Garrett's avatar
Lee Garrett committed
17
file for tips about managing your forked repository and committing code.
18 19


20 21
GPG-signed commits are preferred
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22

23 24 25 26 27 28
The project is developed using a distributed model, and its code is used on
``root`` account in production environments. Because of that, DebOps developers
rely on GPG-signed :command:`git` commits to ensure authenticity of the code
included in the project. Commits without proper GPG signatures will still be
accepted for the time being, to allow the contributors to transition to
a GPG-signing workflow over time.
29 30


31 32
Issues or feature requests
--------------------------
33

34 35
GitHub issues
~~~~~~~~~~~~~
36

37 38 39 40 41
The project's `issue page <https://github.com/debops/debops/issues>`__ on
GitHub can be used to report issues with the code or request new features. If
you have a potential feature already written, you can directly create a pull
request without a separate issue, it will be discussed and reviewed on the pull
request page.
42 43


44 45
General discussion
------------------
46

47 48
Project's mailing list
~~~~~~~~~~~~~~~~~~~~~~
49

50 51 52 53 54
The DebOps project has `a mailing list <https://lists.debops.org/mailman/listinfo/debops-users>`__
which can be used for general discussion about the project, issue reporting,
etc. The list is also used for announcements concerning the project as a whole.
If you plan to use DebOps in your environment, you should subscribe to this
mailing list, it's relatively low volume.
55

56 57
#debops IRC channel
~~~~~~~~~~~~~~~~~~~
58

59
The project maintainers and users hang out on the ``#debops`` IRC channel in
60
the FreeNode network. You can come over for a more real-time discussion or for
61
support questions.