exercism / exercism/docs

[CI] Spell-check for documentation?

未关闭
#29 8 条评论 0 个 reaction 已指派 1 人 已被 @ErikSchierboom 认领 在 GitHub 查看
x:type/ci x:type/docs
主要语言
没有语言数据
星标
52
派生
98
PR 合并指标
30 天内没有已合并 PR

描述

Would it be possible to add spell checking to CI for documentation (both student-facing and reference)?
Possibly extending to all markdown files (or other doc file types) throughout.
Depending on the method used there could be potential to extend to code samples and stubs, for languages that opt-in (may cause issues, for example in C with function names like `strlen()`) .

### Justification:

There are people from all over the world contributing to Exercism. We cannot expect everyone to know the correct way to spell everything. Even for those of us that English is the first language for can quite often have typos or incorrect spellings in documents.

This might additionally help with those persnickety en-* vs en-US issues that sneak in via muscle memory!

At the moment such items can be caught in review, but this is extra load on a reviewer (who also may not recognise the incorrect spelling or typo). Removing this kind of low-level concern from reviewers, testers and integrators is pretty much the reason CI is a thing.

Fixing typos that make it through review requires another PR. PRs for such relatively small issues may not be deemed worthwhile by anyone that does notice the issue. However a CI check can be added with relatively low effort.

### Possible Methods:

There are several spellcheckers that can run in a shell (e.g. GNU Aspell, Hunspell, etc). These could be configured to ignore any inline code sections (or at a stretch, have a script normalise files by removing inline code [[remark](https://github.com/remarkjs/remark)?] before checking). There are some spellcheckers that will even spellcheck code also, though I don't know if these would work well across the variety of languages and associated casing conventions that Exercism covers.

### Caveat:

Any such CI check should at least at first, either (or both) not be blocking, or should allow very easy addition of terms to the dictionary to cover programming and software terms that are not in common use.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。