Skip to content

Add spellcheck CI to repository #5609

Open

Description

@voidzcy

There are tons of typos and spelling errors in our codebase, some are in the code and some are in the comments. As grpc-java is becoming more and more popular, maybe it's time to clean them up and have a required CI task running spellchecking on PRs. It might add some pain when creating PRs, but fixing typos in a single PR should not be too headache and it does things good to us. Envoy's repo is doing very well on this, maybe we could borrow what they are using.

Activity

  1. changed the title [-]Add spellcheck CI to codebase[/-] [+]Add spellcheck CI to repository[/+] on Apr 17, 2019
  2. added this to the Unscheduled milestone on Apr 19, 2019
  3. sf7h commented on Mar 20, 2020

    @sf7h

    Hi! would like to work on this - is it still up for grabs?

  4. voidzcy commented on Mar 20, 2020

    @voidzcy
    ContributorAuthor

    @fathalls Thanks for being interested in this. Sure, you can have a try. Note the existing codebase already has tons of typos, so we may want the tool to just check for future PRs.

  5. sf7h commented on Mar 26, 2020

    @sf7h

    @voidzcy Should we add a pre-commit hook running a script to check the spelling or add a stage as part of Travis CI to check spelling on PRs?
    IMHO First option could be better since it allows the developer to correct the misspellings before a branch is pushed.
    Thoughts?

  6. voidzcy commented on Mar 26, 2020

    @voidzcy
    ContributorAuthor

    Yeah, the first one sounds good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions