Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.38 KB

CONTRIBUTING.rst

File metadata and controls

31 lines (24 loc) · 1.38 KB
Raw

Pull-Request Checklist

MyTardis has been created by a very diverse group of contributors, all with different backgrounds, aims and approaches. We also welcome your contributions. However, to maintain viability of this project given its many contributors, some basic coding standards need to be maintained.

If you're submitting a pull request, please run through this check-list first:

  1. Is your code PEP-8 compliant? Please run pep8.py or equivalent to check.
  2. Does your code lint cleanly? Install pylint and check with pylint --rcfile=.pylintrc.travis tardis
  3. Have you merged or rebased your change against the current master?
  4. Have you run the full suite of Python and JavaScript tests in a clean environment?

If you haven't:

# Clean your environment
unset PYTHON_SETTINGS_MODULE
find . -name '*.py[co]' -delete
# Clean install and full test
python test.py
# Run test server then check Jasmine tests @ http://localhost:8000/jasmine/
python mytardis.py testserver
  1. Does your change introduce new code? You should have tests covering it.
  2. Does your change introduce new features? You should update the documentation in docs/ accordingly.
  3. After you send the pull request, Travis CI will automatically run some tests. Your pull request cannot be accepted until they pass.

If you have any questions, please contact us or submit an issue on github.