Contributing to the CM++ Pipeline

We welcome all helpful contributions to improving CM++ and the CM pipeline. Contributors can help in the following ways:

• Identifying and/or fixing bugs and typos
• Writing tutorials and blog posts
• Creating tests and adding them to the test set
• Proposing new features

How to Contribute

• Commit and pull request to a forked repository
• Adding tutorials and blog posts to this wiki

Asking for Help

• Raise issues. Issues can include bugs and errors with installation and usage, or just suggestions for new features. Before raising an issue, please make sure of the following:
  • Double check that your issue isnt already addressed in the documentation on this website.
  • If you are running into problems with code, ensure that the dependencies and your version of the CM++ Pipeline are up to date
  • Check if an issue has already been posted that addresses your concern.

Community Guidelines

Developer Guidelines

• Please make contributions on a forked repository and we will approve pull requests
• CM++ is majority written in Python. Please ensure you are following the style guidelines
• Please do not use submodules in your pull requests, package them and include them as a part of requirements.txt
• Use appropiate version tags. We follow a standard version.feature.patch format for version tags.
• Make sure you pass all test cases before making a pull request.

Using Appropriate Language

In commit messages, wiki and blog-posts, and issues, we expect that contributors create a positive environment by:

• Using welcoming and inclusive language
• Being respectful of differing viewpoints and experiences
• Focusing on what is best for the community
• Showing empathy towards other community members