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 spell checker and workflow #366

Merged
merged 3 commits into from
Apr 26, 2024
Merged

Add spell checker and workflow #366

merged 3 commits into from
Apr 26, 2024

Conversation

Ainali
Copy link
Member

@Ainali Ainali commented Mar 23, 2024

Adding our first test! 🎉

Keeping it general for now, and I do not think we need anything more specific but should aim to give good messages in the tests when needed.
@Ainali Ainali requested a review from Abbe98 March 23, 2024 07:56
Copy link
Member

@Abbe98 Abbe98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the many allow-listed words already needed, I would expect that false-positives would be very common. Therefore, this action should maybe, instead of failing add a helpful comment mentioning the allow list?

@Ainali
Copy link
Member Author

Ainali commented Apr 2, 2024

I don't know how to get an action to add that comment, but the test will say which word is not in the list. Is that enough? Or should we add some more documentation that explains the list?

@Abbe98
Copy link
Member

Abbe98 commented Apr 7, 2024

My thinking is that it might not be a very good first time experience contributing if there is a false positive test requiring additional changes. An option could be to put the action on a schedule, which would move the burden from contributors to maintainers?

@Ainali
Copy link
Member Author

Ainali commented Apr 7, 2024

If there are false positives, it's not great, true, but I am not sure that there will be many more false positives, as the jargon related to Wikidata and SPARQL is mostly added already. If a contribution has other jargon that is not in aspell, I think it is worth even for new contributors to start thinking if a simpler language can be used.

And also, the burden isn't solely on the contributor when a test fails on PR, but also on the maintainers to help get it right before merging.

@Abbe98
Copy link
Member

Abbe98 commented Apr 26, 2024

I'm convinced to try it out, but if it ends up producing false positives to newcomers I think we should put it on a schedule.

@Ainali Ainali merged commit 28225a4 into main Apr 26, 2024
2 checks passed
@Ainali Ainali deleted the spell-checker branch April 26, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants