Please create a new issue on the issues list.
When reporting a bug, please include:
- The version of scikit-surgerydocker you are using
- Your OS version (for example Windows 10 64-bit, macOS High Sierra, Ubuntu 18.04)
- Detailed steps to reproduce the bug.
- Find an issue you would like to work and assign it to yourself. You can also add new issue to describe your own feature or bugfix.
- Fork the repository
- Create a branch for your changes. The branch name should start with the issue number, followed by hyphen separated words describing the issue. For example:
6-add-contribution-guidelines-to-the-repo - Make your changes following the coding guidelines below.
- Commit and push your changes to the branch on your fork. The commit message should start with
Issue #<issue number>:, for example:Issue #1: Fixed typo. Commit in small, related chunks. Review each commit and explain its purpose in the commit message. - When finished, submit a merge request:
- As few dependencies as possible. Try to stick to standard packages like numpy and pandas etc.
- Discuss extra dependencies with the team and maybe the outcome will be to create a new separate package, where you can be more specific and more modular.
- Unit test well, using pytest, with good coverage.
- All errors as exceptions rather than return codes.
- Please follow PEP8 guidelines.
- Create a python virtual environment (virtualenv) for development
- Make sure that pylint passes. You may disable specific warnings within the code where it is reasonable to do so
- Include comments to make your code easily understandable.
- Add unit tests for new and modified code
- Make sure all existing and new tests pass
- Make sure all docstrings have been added
- Make sure all dependencies have been added to requirements
- Make sure your code works for all required versions of Python
- Make sure your code works for all required operating systems