otto-de / otto-de/api-guidelines
[orga] Provide script for "next free rule number"
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 50
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Context
Each guideline rule has an ID that is displayed in the UI:
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:
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the rule files to determine how IDs are stored, then review CONTRIBUTING.md for the appropriate usage guidance. Provide a manually runnable script that reports the next free rule ID and document how to run it in CONTRIBUTING.md.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100