[repo] Create a writing style
Open
Nobody has claimed this yet.
enhancement
help wanted
repo
tooling
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
We should look at using https://github.com/errata-ai/vale, and there are some great writing guides which we may want to adopt. These are detailed at https://github.com/errata-ai/styles
I'd suggest we look at one or more of:
This is related to #48 but they have different remits.
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 Vale project and the available styles at errata-ai/styles, then compare the proposed Alex, Proselint, Microsoft, Google, Write-good, and Readability rulesets. The issue is complete when a writing style and the ruleset or rulesets to adopt have been selected and documented for the project.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100