microsoft / microsoft/tsdoc

New proposed/proposal tag

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

I propose a new tag @proposed or @proposal. This is because I believe there is intent not fully covered by the existing tags: @experimental, @alpha, @beta.

The suggested @proposed or @proposal tag serves the purpose of documenting a function/member as a proposed idea during peer reviews and pull requests.

Contributor guide

No contributing guide indexed for this repository

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

Start by reviewing how the existing @experimental, @alpha, and @beta tags are defined and documented. Decide whether @proposed or @proposal is the intended spelling, then determine the specification and validation changes needed for the new peer-review status; completion requires an accepted design and corresponding documentation and tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.