microsoft / microsoft/api-guidelines
Add clarity to expand requirement
Open
Nobody has claimed this yet.
Graph Guidelines
Microsoft Graph
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
Expand may be an expensive option in this case therefore a requirement doe expand should state if there is a vialble use case.
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
Locate the guideline text that defines the expand requirement and read its surrounding guidance. Clarify when expand is acceptable despite its potential cost by stating that a viable use case is required; done means the requirement is explicit and understandable to API authors.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100