SparkPost / SparkPost/developers.sparkpost.com
Add textlint
Open
Nobody has claimed this yet.
- Dominant language
- API Blueprint
- Stars
- 18
- Forks
- 9
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 3
Description
We should have some linting on the API reference content to help fix common errors:
textlint rules:
- alex
- max-comma (max 3)
- terminology
terms:SMTP,Transmissions APIetc.,SparkPost,MTA,Message Systems,Momentum,Port25,TPSand other protocols,JSON,PHPand other library languages, - write-good
options: weasel, adverbs, so, illusion, cliches - spellchecker
- stop-words (This might be too aggressive for us)
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 names API reference content but no files, tests, or entry points. Start by locating that content and the project’s content-checking entry point, then use the listed textlint rules and options as the acceptance checklist, including deciding whether stop-words is too aggressive.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100