microsoft / microsoft/api-guidelines
URL path camelCase vs underscore vs dash etc.
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
It would be great if the standards document expressed a clear opinion on how multiple words should be concatenated in URL path segments.
For example:
https://api.contoso.com/v1.0/pullRequests
https://api.contoso.com/v1.0/pull-requests
https://api.contoso.com/v1.0/pull_requests
https://api.contoso.com/v1.0/pullrequests
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 standards document and the existing discussion first, then compare the four URL path examples in the issue. Determine whether the project has an established convention and document a clear recommendation for concatenating multiple words in path segments. Done means the standards document states one unambiguous convention with suitable examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100