Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
49 lines (34 loc) · 2.07 KB

CONTRIBUTING.rst

File metadata and controls

49 lines (34 loc) · 2.07 KB

Contributing to PythonTemplate

We welcome contributions to this Python Template.

Reporting bugs and feature requests

Please create a new issue on https://github.com/SciKit-Surgery/PythonTemplate/issues/new

When reporting a bug, please include: * The version of PythonTemplate you are using * Your OS version (for example Windows 10 64-bit, macOS High Sierra, Ubuntu 16.04) * Detailed steps to reproduce the bug.

Fixing bugs or implement features

The easiest way to contribute is to follow these guidelines:

  1. Look through the issues on https://github.com/SciKit-Surgery/PythonTemplate/issues and assign the relevant issue to yourself. If there is not an existing issue that covers your work, please create one: https://github.com/SciKit-Surgery/PythonTemplate/issues/new
  2. Fork the repository: https://github.com/SciKit-Surgery/PythonTemplate/fork
  3. Create a branch for your changes
  4. Make your changes following the coding guidelines below.
  5. Commit and push your changes to your fork.
  6. Submit a pull request: https://github.com/SciKit-Surgery/PythonTemplate/pull

Coding guidelines

https://cookiecutter.readthedocs.io

  1. Commit in small, related chunks. Review each commit and explain its purpose in the commit message.
  2. Please follow PEP8 guidelines https://www.python.org/dev/peps/pep-0008/ and Cookiecutter guidelines https://cookiecutter.readthedocs.io
  3. Create a python virtual environment (virtualenv) for development
  4. Make sure that pylint passes for projects created using the template. You may disable specific warnings within the code where it is reasonable to do so
  5. Add unit tests for new and modified code where appropriate
  6. Make sure all existing and new tests pass
  7. Make sure all docstrings have been added
  8. Make sure all dependencies have been added to requirements
  9. Make sure your code works for all required versions of Python
  10. Make sure your code works for all required operating systems