From abafb6f35f717ec15edc512d3e7318d497c90dec Mon Sep 17 00:00:00 2001 From: Tristan Williams Date: Tue, 29 Oct 2024 10:16:34 -0400 Subject: Overhaul documentation --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..280e974 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,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 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. -- cgit v1.2.3