Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at

If you are reporting a bug, please include:

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

Rgroup12 could always use more documentation, whether as part of the official Rgroup12 docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at

If you are proposing a feature:

Get Started!

Ready to contribute? Here's how to set up Rgroup12 for local development.

  1. Fork the Rgroup12 repo on GitHub.

  2. Clone your fork locally:

    git clone

  3. Install your local copy with Poetry, this is how you set up your fork for local development:

    cd Rgroup12 poetry install

  4. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass the tests by running pytest

    poetry run pytest

  6. Commit your changes and push your branch to GitHub:

    git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in
  3. The pull request should work for Python 3.7 & 3.8. Check and make sure that the tests pass for all supported R versions.


To run a subset of tests:



A reminder for the maintainers on how to deploy:

GitHub Actions should build and deploy to testPyPI when a pull request is merged into master.

Code of Conduct

Please note that the Rgroup12 project is released with this Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.

UBC-MDS/Rgroup12 documentation built on April 1, 2020, 4:36 a.m.