Description guidelines
Open
Nobody has claimed this yet.
docs:guidelines
- Dominant language
- JSON
- Stars
- 5.8k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 186
Description
What would you like to see added to BCD?
Write guidelines for descriptions.
How impactful do you think this enhancement will be?
Help contributors to write concise and helpful descriptions that are consistent with the rest of BCD.
Do you have anything more you want to share?
Triggered by https://github.com/mdn/browser-compat-data/pull/29294.
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 by reviewing the description-related changes in pull request 29294 and the surrounding BCD contribution context. Add concise guidelines for writing descriptions that are consistent with the rest of BCD; done means contributors have a clear, accessible set of guidelines.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100