microsoft / microsoft/api-guidelines

Add guidance on case folding on enum values

Open
#342 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Azure Guidelines
Dominant language
No language data
Stars
23.3k
Forks
2.7k
PR merge metrics
No merged PRs in 30d

Description

We should update the Azure REST API guidelines to explicitly state that enum values should be treated as case sensitive.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the Azure REST API guidelines and locate the section covering enum values or case folding. Update the guidance to state that enum values should be treated as case sensitive, then verify that the wording is clear and consistent with the surrounding guidelines.

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-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.