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.

Sign up for GitHub

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

Jump to bottom

Require conformance to style standards #472

Closed
thinkingserious opened this issue Oct 4, 2018 · 3 comments · Fixed by #496
Closed

Require conformance to style standards #472

thinkingserious opened this issue Oct 4, 2018 · 3 comments · Fixed by #496
Labels
difficulty: medium fix is medium in difficulty type: twilio enhancement feature request on Twilio's roadmap

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
@thinkingserious thinkingserious added difficulty: medium fix is medium in difficulty hacktoberfest status: help wanted requesting help from the community type: twilio enhancement feature request on Twilio's roadmap labels Oct 4, 2018
@thatfiredev
Copy link
Contributor

According to the Style Guidelines & Naming Conventions, the code must pass through FindBugs and CheckStyle. Both of them have a Maven Library.

My proposed solution is to add these libraries to the pom.xml file and then add the script to .travis.yml to run the checks:

mvn clean checkstyle:checkstyle findbugs:findbugs install

WDYT?

@thinkingserious thinkingserious added status: work in progress Twilio or the community is in the process of implementing and removed help wanted status: help wanted requesting help from the community labels Oct 11, 2018
@thinkingserious
Copy link
Contributor Author

That sounds good, thank you @rosariopfernandes!

@thatfiredev
Copy link
Contributor

thatfiredev commented Oct 11, 2018 •
edited
Loading

I can send a PR. Should be done in less than 24 hours.

@thatfiredev thatfiredev mentioned this issue Oct 12, 2018
Merged
6 tasks
RohanTalip added a commit to RohanTalip/sendgrid-java that referenced this issue Oct 31, 2018
@RohanTalip
Tidied up a little.
58bf3e6 
- (Mostly) automatically reformatted code using IntelliJ IDEA to match the Google Style Guide (as documented in CONTRIBUTING.md).
  - 2 space indent, where it wasn't already.
  - Line wrap at 100 characters, where it wasn't already.
  - Wildcard imports were replaced with explicit imports.
  - Unused imports were removed.
  - Annotations were put onto their own line, and additional lines added for readability where necessary.
  - Braces were added to if-statements that didn't already have them.
- Also made some minor edits, e.g. as suggested by IntelliJ IDEA (e.g. public --> private).

This will help with getting the code into shape before style conformance is required as per issue sendgrid#472 and pull request sendgrid#496.

See also:
- https://github.com/google/google-java-format
- https://plugins.jetbrains.com/plugin/8527-google-java-format
- https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
@RohanTalip RohanTalip mentioned this issue Oct 31, 2018
Merged
6 tasks
RohanTalip added a commit to RohanTalip/sendgrid-java that referenced this issue Feb 4, 2020
@RohanTalip
Tidied up a little.
f780c79 
- (Mostly) automatically reformatted code using IntelliJ IDEA to match the Google Style Guide (as documented in CONTRIBUTING.md).
  - 2 space indent, where it wasn't already.
  - Line wrap at 100 characters, where it wasn't already.
  - Wildcard imports were replaced with explicit imports.
  - Unused imports were removed.
  - Annotations were put onto their own line, and additional lines added for readability where necessary.
  - Braces were added to if-statements that didn't already have them.
- Also made some minor edits, e.g. as suggested by IntelliJ IDEA (e.g. public --> private).

This will help with getting the code into shape before style conformance is required as per issue sendgrid#472 and pull request sendgrid#496.

See also:
- https://github.com/google/google-java-format
- https://plugins.jetbrains.com/plugin/8527-google-java-format
- https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
RohanTalip added a commit to RohanTalip/sendgrid-java that referenced this issue Feb 4, 2020
@RohanTalip
Tidied up a little.
e23f90f 
- (Mostly) automatically reformatted code using IntelliJ IDEA to match the Google Style Guide (as documented in CONTRIBUTING.md).
  - 2 space indent, where it wasn't already.
  - Line wrap at 100 characters, where it wasn't already.
  - Wildcard imports were replaced with explicit imports.
  - Unused imports were removed.
  - Annotations were put onto their own line, and additional lines added for readability where necessary.
  - Braces were added to if-statements that didn't already have them.
- Also made some minor edits, e.g. as suggested by IntelliJ IDEA (e.g. public --> private).

This will help with getting the code into shape before style conformance is required as per issue sendgrid#472 and pull request sendgrid#496.

See also:
- https://github.com/google/google-java-format
- https://plugins.jetbrains.com/plugin/8527-google-java-format
- https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
RohanTalip added a commit to RohanTalip/sendgrid-java that referenced this issue Feb 21, 2020
@RohanTalip
Tidied up a little.
e2e146b 
- (Mostly) automatically reformatted code using IntelliJ IDEA to match the Google Style Guide (as documented in CONTRIBUTING.md).
  - 2 space indent, where it wasn't already.
  - Line wrap at 100 characters, where it wasn't already.
  - Wildcard imports were replaced with explicit imports.
  - Unused imports were removed.
  - Annotations were put onto their own line, and additional lines added for readability where necessary.
  - Braces were added to if-statements that didn't already have them.
- Also made some minor edits, e.g. as suggested by IntelliJ IDEA (e.g. public --> private).

This will help with getting the code into shape before style conformance is required as per issue sendgrid#472 and pull request sendgrid#496.

See also:
- https://github.com/google/google-java-format
- https://plugins.jetbrains.com/plugin/8527-google-java-format
- https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
@childish-sambino childish-sambino removed the status: work in progress Twilio or the community is in the process of implementing label Aug 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty: medium fix is medium in difficulty type: twilio enhancement feature request on Twilio's roadmap
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

test: Add spotbugs and checkstyle maven plugins for Travis CI thatfiredev/sendgrid-java
3 participants
@thinkingserious @thatfiredev @childish-sambino