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

Add textlint #2021

Merged
merged 6 commits into from
Oct 5, 2021
Merged

Add textlint #2021

merged 6 commits into from
Oct 5, 2021

Conversation

massongit
Copy link
Contributor

Fixes https://github.com/github/super-linter/issues/1810

Proposed Changes

(This PR is a modification of a rule that apply based on https://github.com/github/super-linter/pull/2006 )
textlint is a text linter.
If we add it, we can improve the quality of the documents in our repositories.
The rule textlint-rule-terminology and the filter textlint-filter-rule-comments are applied here.

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • Label as breaking if this is a large fundamental change
  • Label as either automation, bug, documentation, enhancement, infrastructure, or performance

@admiralAwkbar
Copy link
Collaborator

@massongit
Im not a big fan of the dead-link as it seems to time out and hit rate limits without a way to resolve.
I noticed when we had added this it was failing every time with rate limits... Im not sure we want to add this if its going to constantly fail and no way to fix that

@massongit
Copy link
Contributor Author

massongit commented Oct 4, 2021

textlint-rule-no-dead-link has the problem you said.
Therefore, I changed to apply textlint-rule-terminology.

@admiralAwkbar
Copy link
Collaborator

@massongit I like this rule a lot better... If you can clean up the package-lock I think I'm good to get this merged up

@admiralAwkbar admiralAwkbar added documentation Improvements or additions to documentation enhancement New feature or request and removed Do-Not-Merge labels Oct 4, 2021
@massongit
Copy link
Contributor Author

I merged main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add textlint
2 participants