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

Ci/lint english #68

Closed
wants to merge 9 commits into from
Closed

Ci/lint english #68

wants to merge 9 commits into from

Conversation

hleonardtek
Copy link
Contributor

@hleonardtek hleonardtek commented Jul 4, 2022

Implement an english linter to check the spelling of the whitepaper files.

  • Full errors location described in the action logs
  • Report sent by mail and commented in the PR
  • Easy custom with dictionaries to enhance vocabulary

@hleonardtek hleonardtek requested review from ccamel, amimart and ad2ien July 4, 2022 17:45
@hleonardtek hleonardtek self-assigned this Jul 4, 2022
@hleonardtek hleonardtek requested a review from ccamel July 4, 2022 21:03
Copy link
Contributor

@ad2ien ad2ien left a comment

Choose a reason for hiding this comment

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

Nice thanks, maybe let's just fix the version.

Copy link
Contributor

@ad2ien ad2ien left a comment

Choose a reason for hiding this comment

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

Ok for me!

@amimart
Copy link
Member

amimart commented Jul 13, 2022

Regarding the comments it did on this PR, I'm not really convinced this linter will be helpful.. Maybe a cron job opening a new PR with spelling and grammar suggestions would fit much, what do you think ?

@ccamel
Copy link
Member

ccamel commented Jul 13, 2022

If you don't mind, I put the PR in draft while we agree on the best approach. Thx.

@ccamel ccamel marked this pull request as draft July 13, 2022 08:21
@ad2ien
Copy link
Contributor

ad2ien commented Jul 13, 2022

Regarding the comments it did on this PR, I'm not really convinced this linter will be helpful.. Maybe a cron job opening a new PR with spelling and grammar suggestions would fit much, what do you think ?

I though it was nice to have a comment on the PR, it gives people a chance to correct their typos. Maybe with a better template?
Opening a PR without changes? an issue maybe then?

@hleonardtek
Copy link
Contributor Author

hleonardtek commented Jul 20, 2022

Yes effectively, like I wrote in the issue, this action doesn't provide relevant information concerning the errors. It only prints the misspelled words in the PR, without the concerned files and precise locations.
We thought it was still better than nothing, while we are searching for building our own solution.

We should build our own action, or even a CJ as said by @amimart.
In my view, an action is more suitable as it will be triggered on changes only.

What are the advantages of a CronJob compared to an action ?

@ccamel ccamel force-pushed the main branch 2 times, most recently from 4be57ee to 681b30d Compare October 29, 2022 06:10
@ccamel ccamel force-pushed the main branch 4 times, most recently from 777dbc2 to 54d7bdc Compare November 21, 2023 19:46
@ccamel
Copy link
Member

ccamel commented Jan 7, 2024

@amimart still relevant?

@amimart
Copy link
Member

amimart commented Jan 7, 2024

@ccamel Would have been great, but seems difficult to continue so I'm in favour of closing it.

@ccamel ccamel closed this Jan 7, 2024
@ccamel ccamel deleted the ci/lint-english branch March 7, 2024 19:26
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.

4 participants