Skip to content
This repository was archived by the owner on Aug 20, 2020. It is now read-only.

Require conformance to style standards #92

Closed
thinkingserious opened this issue Oct 4, 2018 · 3 comments
Closed

Require conformance to style standards #92

thinkingserious opened this issue Oct 4, 2018 · 3 comments

Comments

@thinkingserious
Copy link
Contributor

Issue Summary

In the CONTRIBUTING.md file there is a section on Style Guidelines & Naming Conventions. Please review and implement a check in Travis CI. If there are any style errors, either fix or create a rule to exclude the error.

Before writing any code, we suggest you review our CONTRIBUTING.md file and propose your solution for discussion here in the comments. Thank you!

Aceptance Criteria

  • TravisCI checks that the code conforms to our Style Guidelines & Naming Conventions as defined in our CONTRIBUTING.md file
  • tests pass locally, in Travis CI and using Docker
@ofaltins
Copy link

ofaltins commented Oct 4, 2018

I'd like to look into this.

I've reviewed the Style Guidelines & Naming Conventions section which specifies that contributors should get a pass from ESLint with the standard styleguide.

Additionally, there's the unofficial styleguide which in turn provides an eslint.rc file which can/should take precedence over the standard styleguide if there are any conflicts (TBD?)

If there are a lot of discrepancies between the new eslint.rc file and existing code base, i'd like to circle back to get some guidance on how to proceed.

Once the "final" eslint.rc file is defined, i'd add a lint script in package.json, and add npm run lint in the script section in travis.yml.

Let me know if this is in accordance with your expectations.

@thinkingserious
Copy link
Contributor Author

Hi @ofaltins,

That sounds great, thanks for taking this on!

With Best Regards,

Elmer

@childish-sambino
Copy link
Contributor

Closing all open issues and PRs. This repo is no longer maintained. Please use https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/client instead.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants