kantord/emuto

Add some form of grammar check to CI for documentation

Open

#111 opened on Oct 29, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (8 forks)github user discovery
good first issueresearch

Repository metrics

Stars
 (223 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It would be great to use the CI to run some grammar checks on the docs folder

Contributor guide

Research direction
Check the current CI configuration in the repository and add a grammar checking tool like textlint or write good to the documentation build pipeline.
Tech stack
javascript
Domain
documentationdevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitCI/CD basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90