aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 280e974ec566b8d0123d4e8579b96d0e2147f35a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# How to contribute to SYSTEM

## Guidelines

- Read and understand the documentation in `doc/dev/`, starting with `DEV_MANUAL.md`.
- Make commits, branches, patches, patchsets, and emails limited to "one logical thing".
- Follow the example of what you see in the rest of the codebase.
- Reach out for help if you need assistance.


## How to submit patches

Email patchsets, bug reports, etc. directly to Tristan Williams <tgwil@tgwil.net> using one of the following subject templates:

- Patchsets: `SYSTEM: Patchset: [description of changes]`
- Bug Reports: `SYSTEM: Bug Report: [description of bug]`
- Development Discussion: `SYSTEM: RFC: [description of discussion topic]`
- Questions/Help: `SYSTEM: Help: [description of question]`

Be informative in emails, but don't overwhelm with useless details.