Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add standards/conventions for spelling in Contribution Guide #183

Closed
jsjoeio opened this issue Jul 27, 2020 · 2 comments
Closed

Add standards/conventions for spelling in Contribution Guide #183

jsjoeio opened this issue Jul 27, 2020 · 2 comments
Labels
discussion documentation Improvements or additions to documentation

Comments

@jsjoeio
Copy link
Contributor

jsjoeio commented Jul 27, 2020

@ShaunaGordon brought up a great question:
Do we have any standards/conventions on British vs American English? That's the only other thing I see.

From @jevakallio in same discussion

We absolutely do not have a formal guidance on US/UK English. The documentation, as written by me, is mainly British English, but I feel the internet and programming communities in particular are more accustomed to American English, so at some point we might elect to do a big refactor.

Let me noodle on this. For now, I'll keep this as UK English to conform to existing standards

For now, we may want to add a short line to the Contribution Guide explaining that we should stick to UK English.

Related:

@jsjoeio jsjoeio added documentation Improvements or additions to documentation discussion labels Jul 27, 2020
@Barabazs
Copy link
Contributor

This could be "enforced" with the help of github actions. Here is an example using cspell: https://seankilleen.com/2021/01/adding-spell-checking-to-my-blogs-build-process-with-github-actions-and-cspell/

@daniel-vera-g
Copy link
Contributor

This could be "enforced" with the help of github actions. Here is an example using cspell: https://seankilleen.com/2021/01/adding-spell-checking-to-my-blogs-build-process-with-github-actions-and-cspell/

Yeah, I've got nearly the same working on a private project.

After fixing some markdown errors in the docs recently I wanted to make a PR to lint the docs using gh actions and markdownlint. Will keep this in mind and also add it to the pipeline 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants