Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (27 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

34 lines (27 loc) · 2.49 KB
Raw

Contributing to ocfl-py

Issues and pull requests are appreciated. I apologize if it takes me some time to respond or review..

Submitting issues

In the case of bugs please describe in detail, preferably with a recipe to repeat and demonstrate the problem. Although you should include test data as necessary, please be careful not to include secrets or passwords!

If you propose a major change or new feature, please submit an issue to discuss before moving ahead with a pull request.

Coding style

If submitting a pull request:

  • Understand that this code and any merged contributions are covered by the MIT license
  • First create an issue to discuss the proposed change
  • Please submit pull requests against the main branch
  • Please write code that passes the linting tests in .github/workflows/action.yml, these include:
    • pycodestyle implements PEP8 with the following warnings disabled:
      • Line length is not enforced (E501), just be reasonable
      • Where necessary, line breaks should occur before binary operators (warning W504 is enabled, but W503 is disabled)
    • pydocstyle implements PEP257 style rules:
      • Nothing is disabled
    • pylint implements more complex static analysis and looks for code smells, some rules are disabled including:
  • Other style choices not enforced:
    • Use double quotes (") and triple-double quotes (""") for strings unless there is reason to avoid having to quote these inside
    • Follow something close to the Google Python Style Guide for docstrings. Use Arguments: not Args: however, and triple greater-thans (>>>) for code examples.
  • Please don't repeat code
  • Please cover the code with tests
    • Use unittest style tests in the tests directory, usually one test file per module with the name test_module_name.py
    • You can run coverage checks with run_coverage.sh and output goes in the htmlcov directory