Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.31 KB
Raw

Contributing to mikropml

This document was adapted from the Tidyverse Contributing guide.

Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file.

Bigger changes

If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it's needed. If you've found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).

Pull request process

  • Fork the repo and clone onto your computer.

  • Install all conda and mamba if you don't already have them.

  • Create a Git branch for your pull request (PR).

  • Make your changes, commit to git, and then create a PR. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.

Code of Conduct

Please note that the mikropml-snakemake-workflow project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.