Conversation
OnkarRuikar
requested review from
pepelsbey and
rebloor
and removed request for
a team
github-actions
bot
added
Content:WebExt
|
Preview URLs
External URLs (1)URL:
(comment last updated: 2024-08-13 07:12:42) |
rebloor
left a comment
rebloor
left a comment
There was a problem hiding this comment.
For the corrections to favourite-colour
| - name: Create an issue | ||
| if: env.OUTPUT != '' | ||
| uses: dacbd/create-issue-action@main | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| title: Weekly spelling check | ||
| body: | | ||
| ## Found typos and unknown words: | ||
| ${{ env.OUTPUT }} | ||
|
|
||
| > [!TIP] | ||
| > Add valid words to the https://github.com/mdn/content/blob/main/.vscode/project-words.txt file, and fix the typos. |
There was a problem hiding this comment.
Instead of creating one issue every week, is it possible to keep one dashboard issue that gets updated every week? No strong feelings, just because our issues tend to stack up and get forgotten—not everyone here has the habit of going through past issues.
There was a problem hiding this comment.
I hope the typo issues will not linger more than a day. A maintainer won't even have to wait for a reviewer.
There are many things to handle. We'll have to reopen the issue every week and update it. We might need a custom implementation for this. If you know of any third-party action that does this out of the box, let me know.
How about we merge this as it is and get this bot going, then work on the recurring issue implementation?
|
@OnkarRuikar Perhaps you can split out the content change into a separate PR so it can be quickly merged? #35404 |
github-actions
bot
added
Content:HTML
|
@OnkarRuikar Could you split all content changes into separate PRs? We don't want to loop more and more people into this. |
github-actions
bot
added
size/m
OnkarRuikar
force-pushed
the
infra_spell_bot
branch
from
cc99af8 to
33dda95
Compare
github-actions
bot
added
size/xl
|
I see that they won't be added to editor suggestions. However I think in |
Because the bot was working standalone and the editor consideration was not there so all the words were accumulated in one file. There are 5578 words in the file, and classifying them is a huge time-consuming task. But we can do it later after the bot goes live. If we could force contributors to use camel case variable names then a ton of words will get removed. 🙄 |
OnkarRuikar
force-pushed
the
infra_spell_bot
branch
from
94c1034 to
40c444f
Compare
Co-authored-by: Brian Thomas Smith <[email protected]>
|
I've successfully tested the workflow. |
It looks good, tnx. I think we can merge this shortly. I would also echo the sentiment from Josh that we should try to reduce the 5k+ size dictionary by some means in a follow-up. Like:
|
|
I ran |
nice, thank you
IMO "words" is the part to get rid of in the ignore file, so I'd prefer to keep the original or do something like: What do you reckon? |
|
@bsmth |
bsmth
left a comment
bsmth
left a comment
There was a problem hiding this comment.
Looking good, let's give it a shot! Thanks, Onkar
|
Don't forget to trigger the workflow manually. |
4 participants
I've been running a spell-checker bot in my
temprepo for over 1.5 years. The bot runs every Monday start and files an issue giving details about found typos/spelling mistakes in themdn/contentrepo. The issue is resolved by fixing typos inmdn/contentand adding new words in theproject-words.txtfile.In the last weekly meeting, we got the green signal to move the bot to the content repo. The PR moves the bot to this repo.
The following changes have been made to existing files:
project-words.txtfile contains 5k+ ignored words gathered over the period.valid=truecasefavourite-colour. As the article is named in such a way, we have to ignore all the occurrences.