microsoft / microsoft/api-guidelines
Two letter acronym guidance
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
In our naming guidelines, we say this about two-letter acronyms:
☑️ SHOULD case two-letter acronyms with the same case.
We also don't say anything specific about two-letter abbreviations. I think for ID (which is arguable if it's an acronym or an abbreviation, but I don't think it matters here) we have the general pattern of something like myId rather than myID. I also think that we do the same for other two-letter tokens. I suggest that we either remove this naming convention, or we specifically call out that ID should not follow this pattern.
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 in the naming section of graph/GuidelinesGraph.md, linked from the issue, and compare the two-letter acronym guidance with the existing myId example. Review the surrounding conventions and update the guidance so the treatment of ID and other two-letter tokens is unambiguous; done means the guideline clearly resolves the stated inconsistency.
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
- Mostly clear
- Newbie friendliness
- 35/100