microsoft / microsoft/api-guidelines
Integrate uniform versioning guidelines
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
This is a suggestion to integrate the uniform versioning doc and accompanying glossary from Azure/azure-rest-api-specs into the Azure REST API guidelines doc, or at least reference it. It's a significant addition to the versioning guidelines already there.
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
Start with the API versioning section in azure/Guidelines.md and compare it with the linked uniform versioning document and glossary from Azure/azure-rest-api-specs. Determine whether the material should be integrated or referenced, then update the guidelines so the versioning guidance and glossary are covered or linked.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100