The reason of why we are doing this is because that we don't want to write codes that the others cannot understand or run. If such happens, we need to spend additional time on fixing these, which holds back our process. If we can ensure these things won't happen before it happens and it also won't take too much additional time, why aren't we doing that?
Things to make sure
Check that you've installed pylint, pydocstyle and pytest.
These should be installed if you do exactly what was stated in README.
If not, run this:
pip install -r requirements-dev.txt
Commands to run before commit
pydocstyle msnmetrosim
pylint msnmetrosim
pytest
pydocstyle checks if you have the consistent documentation format comply with PEP-257.
pylint checks if you have any coding style issues.
pytest runs all the tests. For creating test cases, refer to #10.
Notes
If you're interested in automating these things, here are the ways you can do:
The reason of why we are doing this is because that we don't want to write codes that the others cannot understand or run. If such happens, we need to spend additional time on fixing these, which holds back our process. If we can ensure these things won't happen before it happens and it also won't take too much additional time, why aren't we doing that?
Things to make sure
Check that you've installed
pylint,pydocstyleandpytest.These should be installed if you do exactly what was stated in README.
If not, run this:
Commands to run before commit
pydocstylechecks if you have the consistent documentation format comply with PEP-257.pylintchecks if you have any coding style issues.pytestruns all the tests. For creating test cases, refer to #10.Notes
If you're interested in automating these things, here are the ways you can do:
git hook