diff options
| author | Tyler Davis <tyler@gluecode.net> | 2025-01-31 06:07:27 +0000 |
|---|---|---|
| committer | Tyler Davis <tyler@gluecode.net> | 2025-01-31 06:07:27 +0000 |
| commit | 97842d43cc06cdd8e298d74ad6705af4348df49a (patch) | |
| tree | 0c3f2393c03824968ed16128135ca743f1353286 /docs/core.md | |
| parent | 509fe00d541ce769c4423a072318ad47294b7763 (diff) | |
| download | standards-97842d43cc06cdd8e298d74ad6705af4348df49a.tar.gz standards-97842d43cc06cdd8e298d74ad6705af4348df49a.zip | |
Diffstat (limited to 'docs/core.md')
| -rw-r--r-- | docs/core.md | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/docs/core.md b/docs/core.md index d73b122..1e16d54 100644 --- a/docs/core.md +++ b/docs/core.md @@ -1,23 +1,30 @@ # Core Rules and Guidelines for Standards -The following contain both requirements and guidelines for producing Standards documents. +The following contain both requirements and guidelines for producing +Standards documents. ## Terms -- Standards review group (*SRG*): assigned group which reviews and approves changes to the Standards. +- Standards review group (*SRG*): assigned group which reviews and + approves changes to the Standards. ## Requirements -- The SRG MUST review outstanding change requests (PRs) every two weeks (14 days). -- PRs MUST remain open for comment no less than 5 business days (or one week). - - PRs MAY remain open for more than 2 weeks if the discussion is active and ongoing. -- The SRG MUST publish Standards no more frequently than once per week, nor less frequently than once every three months. +- The SRG MUST review outstanding change requests (PRs) every two weeks + (14 days). +- PRs MUST remain open for comment no less than 5 business days (or one + week). + - PRs MAY remain open for more than 2 weeks if the discussion is + active and ongoing. +- The SRG MUST publish Standards no more frequently than once per week, + nor less frequently than once every three months. Docuents MUST: - Follow [RFC-2119](rfc2119.txt). - Be as specific as possible (e.g., no colloquial langauge). -- Be concise and use [active voice](https://writing.wisc.edu/handbook/style/ccs_activevoice/). +- Be concise and use [active + voice](https://writing.wisc.edu/handbook/style/ccs_activevoice/). - Capitalize all words in headings. - Use American English spellings and conventions. @@ -25,4 +32,6 @@ Docuents MUST: All Standards documents: -- SHOULD follow the [Google Style Guide](https://developers.google.com/style/lists#capitalization-and-end-punctuation) for punctuation and capitalization. +- SHOULD follow the [Google Style + Guide](https://developers.google.com/style/lists#capitalization-and-end-punctuation) + for punctuation and capitalization. |