search

winglang / wing

A programming language for the cloud ☁️ A unified programming model, combining infrastructure and runtime code into one language ⚡
https://winglang.io
Other
5.05k stars 198 forks source link

Add a code spellchecking tool #782

Open staycoolcall911 opened 1 year ago

staycoolcall911 commented 1 year ago

We'd like to use this tool (@yoav-steinberg had a good previous experience with it). It should reduce the number of typos in our codebase.

Also look into adding it as a separate github workflow using https://github.com/codespell-project/actions-codespell

tsuf239 commented 1 year ago

Hey @MarkMcCulloh , I would like to take this task too, I have a few questions: Where should the spellchecker run? and when? (is it on dev env after build or only when submitting PR, only as an github action?) Also, how should we treat existing spelling mistakes if exist? (does this tool only marks them, or fixes them too?) thanks a lot in advence :)

MarkMcCulloh commented 1 year ago

I think the spell check should run as a separate workflow with a pull_request_target trigger. Maybe we change this at some point, I just don't want to add more time to main build workflow.

Initially, I think it should just warn on spelling mistakes. We should fix all the ones it finds in the initial PR.

github-actions[bot] commented 1 year ago

Hi,

This issue hasn't seen activity in 60 days. Therefore, we are marking this issue as stale for now. It will be closed after 7 days. Feel free to re-open this issue when there's an update or relevant information to be added. Thanks!