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

[FEATURE REQUEST] Create GHA pipeline with spellcheck for md files #26

Open
1 task
nbeck415 opened this issue Jan 5, 2024 · 0 comments · May be fixed by #28
Open
1 task

[FEATURE REQUEST] Create GHA pipeline with spellcheck for md files #26

nbeck415 opened this issue Jan 5, 2024 · 0 comments · May be fixed by #28
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@nbeck415
Copy link
Contributor

nbeck415 commented Jan 5, 2024

Is your feature request related to a problem? Please describe.

Most IDEs don't offer spellcheck when working with markdown, leading to spelling errors.

Describe the solution you'd like

Create a simple GHA pipeline that uses actions to:

  1. Check markdown links (check out gaurav-nelson/github-action-markdown-link-check)
  2. Check spelling (check out codespell-project/actions-codespell@v2)

Ideally, this should ONLY apply to markdown files (and maybe index.html..). Md files are conveniently in their own directory.

Ping me if you have any questions.

List alternatives you've considered

N/A

Additional context

Feel free to add any additional actions that are relevant to text quality

Assign to self

Check this box if you'd like to take on the issue:

  • I would like to work on this issue
@nbeck415 nbeck415 added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jan 5, 2024
@thecodingaviator thecodingaviator linked a pull request Jan 8, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant