Skip to content

Commit

Permalink
chore(docs): Update CONTRIBUTING.md (#69)
Browse files Browse the repository at this point in the history
- Remove the `R00` prefix matching in the proposed one-liner as it
artificially filters out valid matches. We have guideline IDs that start
with `R1`, `R2` etc. By only matching for `R00` we filter out many valid
IDs that could already be taken.
- Add toc entry that was forgotten in
#67
- Clarify rule ID structure

---------

Co-authored-by: Christina Framke <[email protected]>
  • Loading branch information
kiriakos and cgebken authored May 7, 2024
1 parent 8acf2ea commit 77a5a28
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Skip to:
- [Create a pull request draft](#create-a-pull-request-draft)
- [Compose a changelog relevant pull request](#compose-a-changelog-relevant-pull-request)
- [Review a pull request (checklist)](#review-a-pull-request-checklist)
- [Add a new guideline](#add-a-new-guideline)
- [Report a bug](#report-a-bug)
- [Suggest a feature](#suggest-a-feature)

Expand Down Expand Up @@ -101,10 +102,11 @@ Changelog:

You are welcome to propose a new API guideline.
Each API guideline requires a unique rule ID, which must be noted in the front matter of the file.
A rule ID consists of an "R" followed by 6 digits, for example, `R200023`.
To identify an unused and thus available rule ID, run the following command:

```bash
grep -r "^id: R00" api-guidelines | rev | cut -d" " -f1 | rev | sort | less
grep -r "^id: R" api-guidelines | rev | cut -d" " -f1 | rev | sort | less
```

You can choose any rule ID that is not included in the list.
Expand Down

0 comments on commit 77a5a28

Please sign in to comment.