Implement "standard" CI tools #10
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This implements some popular structure and tools to make it easier to work on this project at scale. The patch introduces several testing and linting tools that will make it easier to know if you're contributing something of quality. This follows the openstack model. Please read: https://keepingitclassless.net/2015/10/benefits-development-environment/ Signed-off-by: Matt Oswalt <[email protected]>
Open
Signed-off-by: Matt Oswalt <[email protected]>
Signed-off-by: Matt Oswalt <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This implements some popular structure and tools to make it easier to
work on this project at scale. The patch introduces several testing and
linting tools that will make it easier to make quality contributions.
In short, Travis CI will run three commands to vet incoming Pull Requests:
tox -epep8: This runs PEP8 and other style checks on your codetox -epy27: This runs unit teststox -ecover: This runs coverage testingThese tools are all present in the repository. So, as long as you have
pipandvirtualenvinstalled and up to date, you should be able to run these same checks on your own machine, so you know before pushing any code if you're consistent with the standards.This follows the openstack model. Please read this blog post for some more information on the value of a proper development environment.
This PR still fails the TravisCI build because of PEP8 issues. I decided not to address these here so that someone else can have the opportunity to fix these in a PR of their own, and in doing so, fix the build 😄. I opened #11 to track this - if you want to work on that, let us know there!