api-guidelines icon indicating copy to clipboard operation
api-guidelines copied to clipboard

[orga] Provide script for "next free rule number"

Open cgebken opened this issue 1 year ago • 0 comments

Context

Each guideline rule has an ID that is displayed in the UI: Bildschirmfoto 2024-04-24 um 17 31 40

These IDs are used in the URLs and to clearly reference rules.

When creating a new rule, contributors must add a rule ID at the very beginning of their file: Bildschirmfoto 2024-04-24 um 17 33 15

Currently, they do not know which ID to put / which ID is up next / is already used. We would like to motivate people to contribute to our guidelines. Thus, we should keep the effort to suggest a new rule as low as possible.

Goal

We should at least provide some minimal guidance.

  • [ ] Provide a script users can manually run to get the next free rule ID.
  • [ ] Add the script to the Contributing file.

cgebken avatar Apr 24 '24 15:04 cgebken