Proposal to run spell check on GItHub Actions

52 views
Skip to first unread message

Masafumi Okura

unread,
Oct 27, 2019, 10:20:34 AM10/27/19
to Ruby on Rails: Core
Hi,


I see many Pull Requests fixing typos in documents. This can be done mostly automatically by machines.
I found there's a good tool to find misspells. https://github.com/client9/misspell
If we can run this tool on CI, we can reduce the number of Pull Requests just fixing typos.

richard schneeman

unread,
Oct 27, 2019, 2:43:52 PM10/27/19
to Ruby on Rails: Core
As someone who has commit to the project merging in spelling corrections takes almost no time. I don't think getting fewer of these PRs would be a huge net win (others with commit might disagree). As an occasional writer of features and docs, it would be nice to get feedback right away that I had made an error, but I find spell checking for technical documentation to be very error-prone. I usually turn it off for my editors due to the sheer volume of false spelling flags. If we did adopt some kind of a spell checker I would want it to be more for information purposes than as a hard blocker. If the accuracy looks good then we could eventually make it mandatory.


--
You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group.
To unsubscribe from this group and stop receiving emails from it, send an email to rubyonrails-co...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/rubyonrails-core/cd70b713-02a1-4812-b6f8-01dbdfa7ce01%40googlegroups.com.


--
Richard Schneeman
https://www.schneems.com

Masafumi Okura

unread,
Oct 29, 2019, 3:03:27 AM10/29/19
to Ruby on Rails: Core
Hi Richard,

I understand your concern. I'm not really familiar with spell checking on technical documents, so I'd like to stop this discussion here. If I get more familiar with how to introduce informational spell checker, I'll come to give a proposal again.


On Monday, October 28, 2019 at 3:43:52 AM UTC+9, richard schneeman wrote:
As someone who has commit to the project merging in spelling corrections takes almost no time. I don't think getting fewer of these PRs would be a huge net win (others with commit might disagree). As an occasional writer of features and docs, it would be nice to get feedback right away that I had made an error, but I find spell checking for technical documentation to be very error-prone. I usually turn it off for my editors due to the sheer volume of false spelling flags. If we did adopt some kind of a spell checker I would want it to be more for information purposes than as a hard blocker. If the accuracy looks good then we could eventually make it mandatory.


On Sun, Oct 27, 2019 at 9:20 AM Masafumi Okura <masafu...@gmail.com> wrote:
Hi,


I see many Pull Requests fixing typos in documents. This can be done mostly automatically by machines.
I found there's a good tool to find misspells. https://github.com/client9/misspell
If we can run this tool on CI, we can reduce the number of Pull Requests just fixing typos.

--
You received this message because you are subscribed to the Google Groups "Ruby on Rails: Core" group.
To unsubscribe from this group and stop receiving emails from it, send an email to rubyonra...@googlegroups.com.

Dana Sherson

unread,
Oct 29, 2019, 9:06:05 PM10/29/19
to Ruby on Rails: Core
Hi friends, in case it's relevant, i've recently built a source-code focused spell checker in ruby https://github.com/robotdana/spellr designed to be part of CI pipelines

Rafael Mendonça França

unread,
Oct 29, 2019, 10:23:45 PM10/29/19
to 'Jake Niemiec' via Ruby on Rails: Core
While I agree we should try to avoid typos in our codebase.

Fixing typos It is a very easy and low barrier way to get new contributors, and I think this kind of contribution is very welcome, so I’d prefer to not discourage or even remove the possibility of people to submit typo PRs.

Maybe, someday, someone start with a PR to fix a typo (https://github.com/rails/rails/commit/a0552d653b00e2e5b77e086b155e89fa22e4d6ed) and end up in the top of this list https://contributors.rubyonrails.org/.

To unsubscribe from this group and stop receiving emails from it, send an email to rubyonrails-co...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/rubyonrails-core/eb29ae0b-0c1a-4de0-aefe-95a01f9952a9%40googlegroups.com.

Reply all
Reply to author
Forward
0 new messages