Thank you for your interest in contributing to microbetag! This guide outlines the recommended workflow for contributing code or documentation.
- Fork the Repository
Click the Fork button on the top right of microbetag and clone your fork locally:
git clone https://github.com/<your-username>/microbetag.git
cd microbetag
- Set Up Remotes
Add the upstream repository to keep your fork in sync:
git remote add upstream https://github.com/msysbio/microbetag.git
git remote -v
This should show:
origin https://github.com/<your-username>/microbetag.git (fetch)
origin https://github.com/<your-username>/microbetag.git (push)
upstream https://github.com/msysbio/microbetag.git (fetch)
upstream https://github.com/msysbio/microbetag.git (push)
Before starting a new feature or fix, make sure your local repository is up to date:
git fetch upstream
git checkout develop
git pull upstream develop --rebase
Use a descriptive name for your branch:
git checkout -b feature/my_descriptive_branch_name
Alternatively, if you're continuing from a prior state:
git branch feature/the_fastest_sampling_algo_ever
git checkout feature/the_fastest_sampling_algo_ever
Push your branch to your fork (replace origin with your fork name if different):
git push -u origin feature/my_descriptive_branch_name
The -u flag sets the upstream tracking branch, so future git push/pull commands are simpler.
-
Go to your fork on GitHub.
-
Click Compare & pull request.
-
Base branch should be
develop, and compare should be your feature branch. -
Add a clear title and description explaining your changes.
-
Link any related issues or discussions.
-
Submit the pull request.
-
Write clear commit messages.
-
Test your code before opening a PR; it's a good thing to provide a new test when building a new feature.
-
Use draft PRs if you're still working but want early feedback.