Spell Check GH Action #31

TidbitsJS · 2021-04-07T14:50:59Z

Have you read the Contributing Guidelines on Pull Requests?

Yes

Description

Created a GitHub spell checking action

Checklist

I've read the contribution guidelines.
I've checked the issue list before deciding what to submit.
I've edited the README.md and link to my code.

Related Issues or Pull Requests

Closes: #5

vercel · 2021-04-07T14:51:03Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/neoalgo-docs/neo-algo-docs/BFWzMjmnQtg96rjtLLvUP9k1zpxX
✅ Preview: https://neo-algo-docs-git-fork-tidbitsjs-spellcheckgh-neoalgo-docs.vercel.app

TidbitsJS · 2021-04-07T14:52:19Z

Let me know whether this is the right one or not @HarshCasper :)

vybhav72954

Thanks for contributing to NeoAlgo.

I have suggested a few changes, kindly get them done!!!

vybhav72954 · 2021-04-08T05:58:48Z

.github/workflows/spelling_action.yml

@@ -0,0 +1,15 @@
+name: Spellcheck Action
+on: push


Hey @TidbitsJS first of all the action should be triggered on both push and pull requests, kindly make the required changes.

Use master for branch flag.

vybhav72954 · 2021-04-08T06:04:40Z

.github/workflows/spelling_action.yml

+    - uses: rojopolis/spellcheck-github-actions@0.11.0
+      name: Spellcheck
+      with:
+        source_files: "**/*.md"


I see you have added the source_files tab, but one important thing is missing.

See this issue I opened in the Repo, I have posted a solution I found as well along with other available solutions (which are better).

Kindly incorporate them in your action as well.

The thing is as of now this action will create a lot of noise because it will check each and every md file in the codebase whenever a file is pushed/pull request made. Obviously, we don't want that. The solution for the problems can be found in the thread I mentioned above.

Please try to integrate them here as well.

vybhav72954 · 2021-04-08T06:06:55Z

.wordlist.txt

@@ -0,0 +1,16 @@
+Docusaurus


In case you find it helpful, this is my wordlist, try adding a few words as per your understanding in your wordlist.

TidbitsJS · 2021-04-08T16:21:59Z

@vybhav72954, I have made the changes.
Let me know whether it is correct or not :)

vybhav72954 · 2021-04-08T16:30:07Z

@TidbitsJS I think the additions are good, but can you please test this action once as well?

TidbitsJS · 2021-04-08T16:34:34Z

@TidbitsJS I think the additions are good, but can you please test this action once as well?

I actually have tested this on push. But I think, it's working as usual ( like the previous one ).
I will be needing your help with that.

vybhav72954 · 2021-04-08T16:39:19Z

We can do two things, either I can run a few tests locally on my system. or we can do it on a separate branch in your fork.

TidbitsJS · 2021-04-08T16:45:52Z

We can do two things, either I can run a few tests locally on my system. or we can do it on a separate branch in your fork.

Okay.
How about both of us testing that out? 😄
I will create a separate branch in my fork & will share the result.

TidbitsJS · 2021-04-08T17:16:29Z

@vybhav72954, I tested it on a pull request from a test to the main branch.
At the start, it's showing all the possible misspelled words.
& when I push changes ( wrong words ), then it's showing the previous misspelled words ( which I left as it is, without correcting ) + new ones.
If I remove any other word from wordList then the action is showing that misspelled word on the next push as well.

Is this the expected behavior?

vybhav72954 · 2021-04-08T17:47:12Z

@vybhav72954, I tested it on a pull request from a test to the main branch.
At the start, it's showing all the possible misspelled words.
& when I push changes ( wrong words ), then it's showing the previous misspelled words ( which I left as it is, without correcting ) + new ones.
If I remove any other word from wordList then the action is showing that misspelled word on the next push as well.

Is this the expected behavior?

Yup, that's the problem actually with the action used. It works on the whole codebase, no mater what (if I am actually understanding what you are saying 😛)

Can you tell me which branch you are using for testing, I think I need to take a closer look as am getting a bit confused.

TidbitsJS · 2021-04-08T17:54:51Z

@vybhav72954, I tested it on a pull request from a test to the main branch.
At the start, it's showing all the possible misspelled words.
& when I push changes ( wrong words ), then it's showing the previous misspelled words ( which I left as it is, without correcting ) + new ones.
If I remove any other word from wordList then the action is showing that misspelled word on the next push as well.
Is this the expected behavior?

Yup, that's the problem actually with the action used. It works on the whole codebase, no mater what (if I am actually understanding what you are saying )

Can you tell me which branch you are using for testing, I think I need to take a closer look as am getting a bit confused.

You got me 😅
Yeah, here is the pull request where I checked the test - link, branch name - testSpellCheck ( There is another branch as well, named spellCheck, which I was trying previously )

vybhav72954 · 2021-04-08T17:56:55Z

@vybhav72954, I tested it on a pull request from a test to the main branch.
At the start, it's showing all the possible misspelled words.
& when I push changes ( wrong words ), then it's showing the previous misspelled words ( which I left as it is, without correcting ) + new ones.
If I remove any other word from wordList then the action is showing that misspelled word on the next push as well.
Is this the expected behavior?

Yup, that's the problem actually with the action used. It works on the whole codebase, no mater what (if I am actually understanding what you are saying )

Can you tell me which branch you are using for testing, I think I need to take a closer look as am getting a bit confused.

You got me 😅
Yeah, here is the pull request where I checked the test - link, branch name - testSpellCheck ( There is another branch as well, named spellCheck, which I was trying previously )

Great you have performed enough tests here. Let me see how i can help

TidbitsJS · 2021-04-08T18:04:09Z

@vybhav72954, I tested it on a pull request from a test to the main branch.
At the start, it's showing all the possible misspelled words.
& when I push changes ( wrong words ), then it's showing the previous misspelled words ( which I left as it is, without correcting ) + new ones.
If I remove any other word from wordList then the action is showing that misspelled word on the next push as well.
Is this the expected behavior?

Yup, that's the problem actually with the action used. It works on the whole codebase, no mater what (if I am actually understanding what you are saying )
Can you tell me which branch you are using for testing, I think I need to take a closer look as am getting a bit confused.

You got me sweat_smile
Yeah, here is the pull request where I checked the test - link, branch name - testSpellCheck ( There is another branch as well, named spellCheck, which I was trying previously )

Great you have performed enough tests here. Let me see how i can help

Yes, waiting for your solution :)

vybhav72954 · 2021-04-13T13:09:19Z

@vybhav72954, I tested it on a pull request from a test to the main branch.
At the start, it's showing all the possible misspelled words.
& when I push changes ( wrong words ), then it's showing the previous misspelled words ( which I left as it is, without correcting ) + new ones.
If I remove any other word from wordList then the action is showing that misspelled word on the next push as well.
Is this the expected behavior?

Yup, that's the problem actually with the action used. It works on the whole codebase, no mater what (if I am actually understanding what you are saying )
Can you tell me which branch you are using for testing, I think I need to take a closer look as am getting a bit confused.

You got me sweat_smile
Yeah, here is the pull request where I checked the test - link, branch name - testSpellCheck ( There is another branch as well, named spellCheck, which I was trying previously )

Great you have performed enough tests here. Let me see how i can help

Yes, waiting for your solution :)

Hey @TidbitsJS
Can you have a look at this action

Spell-Checker is taking a bit too much time. Here is an instance where I was able to identify the Files changes in PR but there is still a bit too much noise.

TidbitsJS · 2021-04-14T16:13:15Z

@vybhav72954, I tested it on a pull request from a test to the main branch.
At the start, it's showing all the possible misspelled words.
& when I push changes ( wrong words ), then it's showing the previous misspelled words ( which I left as it is, without correcting ) + new ones.
If I remove any other word from wordList then the action is showing that misspelled word on the next push as well.
Is this the expected behavior?

Yup, that's the problem actually with the action used. It works on the whole codebase, no mater what (if I am actually understanding what you are saying )
Can you tell me which branch you are using for testing, I think I need to take a closer look as am getting a bit confused.

You got me sweat_smile
Yeah, here is the pull request where I checked the test - link, branch name - testSpellCheck ( There is another branch as well, named spellCheck, which I was trying previously )

Great you have performed enough tests here. Let me see how i can help

Yes, waiting for your solution :)

Hey @TidbitsJS
Can you have a look at this action

Spell-Checker is taking a bit too much time. Here is an instance where I was able to identify the Files changes in PR but there is still a bit too much noise.

Okay. I'll go through it & will make changes accordingly.

Thank you for helping me :)

vybhav72954 · 2021-05-13T18:19:32Z

@TidbitsJS Hey man, any luck with the action?

ankitaggarwal23

Closing this due to inactivity since last 21 days. Thank you for your valuable time.😊

spell checker

96ba3e4

vercel bot deployed to Preview April 7, 2021 14:51 View deployment

vybhav72954 suggested changes Apr 8, 2021

View reviewed changes

HarshCasper added gssoc21 Level3 PR:Under-Review labels Apr 8, 2021

gh action update

cba555e

vercel bot deployed to Preview April 8, 2021 16:20 View deployment

ankitaggarwal23 reviewed May 30, 2021

View reviewed changes

ankitaggarwal23 closed this May 30, 2021

ankitaggarwal23 removed the Level3 label May 30, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spell Check GH Action #31

Spell Check GH Action #31

TidbitsJS commented Apr 7, 2021

vercel bot commented Apr 7, 2021 •

edited

TidbitsJS commented Apr 7, 2021

vybhav72954 left a comment

vybhav72954 Apr 8, 2021

vybhav72954 Apr 8, 2021 •

edited

vybhav72954 Apr 8, 2021 •

edited

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 13, 2021

TidbitsJS commented Apr 14, 2021

vybhav72954 commented May 13, 2021

ankitaggarwal23 left a comment

Spell Check GH Action #31

Spell Check GH Action #31

Conversation

TidbitsJS commented Apr 7, 2021

Have you read the Contributing Guidelines on Pull Requests?

Description

Checklist

Related Issues or Pull Requests

vercel bot commented Apr 7, 2021 • edited

TidbitsJS commented Apr 7, 2021

vybhav72954 left a comment

Choose a reason for hiding this comment

vybhav72954 Apr 8, 2021

Choose a reason for hiding this comment

vybhav72954 Apr 8, 2021 • edited

Choose a reason for hiding this comment

vybhav72954 Apr 8, 2021 • edited

Choose a reason for hiding this comment

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 8, 2021

TidbitsJS commented Apr 8, 2021

vybhav72954 commented Apr 13, 2021

TidbitsJS commented Apr 14, 2021

vybhav72954 commented May 13, 2021

ankitaggarwal23 left a comment

Choose a reason for hiding this comment

vercel bot commented Apr 7, 2021 •

edited

vybhav72954 Apr 8, 2021 •

edited

vybhav72954 Apr 8, 2021 •

edited