Configure flake8 and yapf with pre-commit - Githubissues

OpenSourceHelpCommunity / OpenSourceHelpCommunity.github.io

Open source help community website

http://opensourcehelpcommunity.herokuapp.com/

MIT License

44 stars 57 forks source link

Configure flake8 and yapf with pre-commit #215

Closed vinaypuppal closed 6 years ago

vinaypuppal commented 6 years ago

Checklist

[x] My branch is up-to-date with the upstream develop branch.
[x] I have added necessary documentation (if appropriate).

Which issue does this PR fix?: fixes #130

Why do we need this PR?: To ensure that all the code we write follows the standard convention.

What is the new behavior?

[x] Configured Flake8 linter.
[x] Configured yapf (a python code formatter from google).
[x] Configured pre-commit so flake8 and yapf are run for every git commit.
[x] Updated Readme on how to install pre-commit hooks.
[x] Updated travis.yml to run all precommit-hooks on changed files

Testing instructions:

Change some file/s in codebase.
Add file/s to staging.
Commit file/s to git.
If there is some linting or formatting issue then committing will be stopped.
If its formatting issue yapf will make changes in place so add changed files to staging again and run git commit agin.
If its lint issue fix them, add changed files to staging again and run git commit agin.

coveralls commented 6 years ago

Coverage remained the same at 72.269% when pulling 4586475e8c45f608e829329e17e4670792ba62f1 on vinaypuppal:precommit into ea6096f7e2c062fcddaef66f34fc43769fdc2cbd on OpenSourceHelpCommunity:predev.