microsoft / microsoft/api-guidelines

Create guidance for deprecating versions & version discovery...

Open
#356 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

As of PR #352 we removed the section on version discovery because this was out of date. However, we do need to provide guidance on how developers can understand when things are deprecated and what versions are supported.

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 PR #352 and the surrounding API guidelines to understand why the version-discovery section was removed. Define guidance that explains how developers can identify deprecated features and determine supported versions; done means the guidance is added to the appropriate documentation location and addresses both concerns.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.