Add textlint
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation, tooling
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.
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)
- Dominant language
- API Blueprint
- Stars
- 18
- Forks
- 9
- Avg merge
- 8d 7h
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from SparkPost/developers.sparkpost.com
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
SparkPost/developers.sparkpost.com#501 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 32/100
All issues in SparkPost/developers.sparkpost.com
Similar issues
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
agent-reported area/browser area/docs documentation good first issue hacktoberfest help wanted P2
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 2 days