Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
2 tasks
cgebken opened this issue Apr 24, 2024 · 0 comments
Open
2 tasks

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

cgebken opened this issue Apr 24, 2024 · 0 comments

Comments

@cgebken
Copy link
Contributor

cgebken commented Apr 24, 2024

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant