2 ms·
I often see GitHub projects, maybe from people who are not native English speakers, with bad grammar in the Readme.md . Is it OK to create an issue pointing out
by Bostonian 6y ago
I often see GitHub projects, maybe from people who are not native English speakers, with bad grammar in the Readme.md . Is it OK to create an issue pointing out spelling and grammar errors and suggesting fixes? Resolving such an issue will not improve the code but can make the project more accessible.
- vbezhenar 6y agoMy English is poor and I'd love such fixes. But, I guess, it comes down to a person. What I think is worth discussing before suggesting are "polite correct" fixes like "blacklist -> blocklist", "master -> main", "he -> them", etc. Not everyone is fine with this new agenda and one might find those fixes offensive. I'm not saying that those fixes are not appropriate everywhere, just that it's worth discussing before submitting to avoid a pointless debate.
- mplanchard 6y agoPersonally I would much prefer this, especially as a PR, than nitpicking about default (and configurable) colors like in the linked issue. Even as a native English speaker, I frequently make typos, and I’ll often wind up with weird phrasing or grammar due to consecutive rounds of editing things out.