microsoft / microsoft/vscode-docs
UX Guidelines | Provide contextual information alongside do's / dont's
Open
Nobody has claimed this yet.
doc-enhancement
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 5.8k
- Avg merge
- 11h 43m
- Merged PRs (30d)
- 123
Description
To further assist extension developers to make the best UI/UX choices for their functionality, provide more contextually relevant information e.g why should I choose one UI element over another.
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
The issue does not name a file, test, or specific UX Guidelines section. Start by locating the existing do/don't guidance for extension developers and review where contextual explanations are missing. Done means the relevant guidance includes context explaining why one UI element is preferred over another.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100