Skip to content

ensure a consistent style for all changes #51

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

Merged
merged 4 commits into from
Dec 17, 2018

Conversation

softprops
Copy link
Contributor

Issue #, if available:

Description of changes:

I found in another pull that I wasn't able to fmt sources without incurring a bigger git diff of unrelated files. Formatting files is actually good for contributors because its often a feature of rust's efforts to improve the quality of life tools like rls and its vscode extension ( which auto formats on save ). Consistency is also good for readability.

Included is

  • an updated travis config adds a nightly check ( the rustfmt config this project uses requires nightly ) for rustfmt
  • an update to contributing file to give contributors a heads up
  • some helpful links for those new to the project ( and rustfmt ) what these style configs rules do

By submitting this pull request

  • I confirm that my contribution is made under the terms of the Apache 2.0 license.
  • I confirm that I've made a best effort attempt to update all relevant documentation.

@softprops
Copy link
Contributor Author

going to wait on travis before actually applying the style rules to see what happens in the case the style rules aren't honored

@softprops
Copy link
Contributor Author

check seemed to fail without fmting so that worked

screen shot 2018-12-18 at 12 31 16 am

screen shot 2018-12-18 at 12 32 49 am

@softprops
Copy link
Contributor Author

noting here that the ALLOW_FAILURES=true env var probably doesn't do what you think it does

@davidbarsky
Copy link
Contributor

noting here that the ALLOW_FAILURES=true env var probably doesn't do what you think it does

Damn, okay. I'll need to learn how Travis works one of these days.

I found in another pull that I wasn't able to fmt sources without incurring a bigger git diff of unrelated files. Formatting files is actually good for contributors because its often a feature of rust's efforts to improve the quality of life tools like rls and its vscode extension ( which auto formats on save ). Consistency is also good for readability.

Totally agree. I was using rustfmt 1.0, but Travis, for whatever reason, had 0.99, which had a slightly different formatting config, which would cause failures.

Thanks for setting this up!

@davidbarsky davidbarsky self-requested a review December 17, 2018 15:54
@davidbarsky davidbarsky merged commit d117272 into awslabs:master Dec 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants