Getting Started

Ready to contribute? Here’s how to set up Biomathhh for local development.

  1. Fork the https://github.com/ubc-mds/biomathhh repository on GitHub.

  2. Clone your fork locally (if you want to work locally)

    git clone git@github.com:your_name_here/biomathhh.git

  3. Install hatch.

  4. Create a branch for local development using the default branch (typically main) as a starting point. Use fix or feat as a prefix for your branch name.

    git checkout main
git checkout -b fix-name-of-your-bugfix

    Now you can make your changes locally.

  5. When you’re done making changes, apply the quality assurance tools and check that your changes pass our test suite. This is all included with tox

    hatch run test:run

  6. Commit your changes and push your branch to GitHub. Please use semantic commit messages.

    git add .
git commit -m "fix: summarize your changes"
git push -u origin fix-name-of-your-bugfix

  7. Open the link displayed in the message when pushing your new branch in order to submit a pull request.

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.
  3. Your pull request will automatically be checked by the full test suite. It needs to pass all of them before it can be considered for merging.