otto-de / otto-de/api-guidelines
[new rule] create a new rule to deal with scope changes
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 50
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Context
We figured that we need a guideline on how to deal with scope changes. The existing rules focus too much on request/response bodies. The rule should belong in the compatibility section.
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
Read the existing rules in the compatibility section, especially those focused on request and response bodies. Define and document a guideline for handling scope changes, with completion marked by a clear new rule in that section.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100