diff options
| author | Tristan Williams <tgwil@tgwil.net> | 2024-10-29 10:16:34 -0400 |
|---|---|---|
| committer | Tristan Williams <tgwil@tgwil.net> | 2024-10-29 10:16:34 -0400 |
| commit | abafb6f35f717ec15edc512d3e7318d497c90dec (patch) | |
| tree | b5647300656578be064fbbaffc0b7bc0ba5e76f2 /CONTRIBUTING.md | |
| parent | Rename old thing to SYSTEM (diff) | |
| download | template.cl-abafb6f35f717ec15edc512d3e7318d497c90dec.tar.gz template.cl-abafb6f35f717ec15edc512d3e7318d497c90dec.tar.bz2 template.cl-abafb6f35f717ec15edc512d3e7318d497c90dec.zip | |
Overhaul documentation
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..280e974 --- /dev/null +++ b/CONTRIBUTING.md | |||
| @@ -0,0 +1,20 @@ | |||
| 1 | # How to contribute to SYSTEM | ||
| 2 | |||
| 3 | ## Guidelines | ||
| 4 | |||
| 5 | - Read and understand the documentation in `doc/dev/`, starting with `DEV_MANUAL.md`. | ||
| 6 | - Make commits, branches, patches, patchsets, and emails limited to "one logical thing". | ||
| 7 | - Follow the example of what you see in the rest of the codebase. | ||
| 8 | - Reach out for help if you need assistance. | ||
| 9 | |||
| 10 | |||
| 11 | ## How to submit patches | ||
| 12 | |||
| 13 | Email patchsets, bug reports, etc. directly to Tristan Williams <tgwil@tgwil.net> using one of the following subject templates: | ||
| 14 | |||
| 15 | - Patchsets: `SYSTEM: Patchset: [description of changes]` | ||
| 16 | - Bug Reports: `SYSTEM: Bug Report: [description of bug]` | ||
| 17 | - Development Discussion: `SYSTEM: RFC: [description of discussion topic]` | ||
| 18 | - Questions/Help: `SYSTEM: Help: [description of question]` | ||
| 19 | |||
| 20 | Be informative in emails, but don't overwhelm with useless details. | ||