summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 62509ea6b8d7e8d670d4ff46a17d237d0f8c4ea4 (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
Contributing
============

Overview
--------

- We do not currently have a test suite.
- Update `NEWS.md.in`.
- Update `rcm.7`.
- Submit a pull request on GitHub.

Explanation
-----------

Since we do not yet have a test suite, you should make sure to install
and try your patch in a various scenarios. We will also entertain a
contribution with a test case.

Consider updating `NEWS.md.in`. The topmost section is for the upcoming
release. Bugfixes should be marked with `BUGFIX`. Small things (typos,
code style) should be grouped but with multiple authors (`Documentation
updates thanks to Dan Croak and Roberto Pedroso`).

Ensure your name is in the list of contributors in `man/rcm.7`. These
are alphabetical.

Submit a pull request using GitHub. If there is a relevant bug, mention
it in the commit message (`Fixes #42.`).