Contributing to CGLab repositories

Thank you for contributing! This guide applies to all repositories under the cgenomicslab organization.

Workflow

1. Create a feature branch from main: git checkout -b your-initials/description
2. Make your changes with clear, descriptive commits
3. Push your branch and open a pull request
4. Request a review from at least one team member
5. After approval, merge your PR and delete the branch

Commit messages

Start with a verb: Add, Fix, Update, Remove, Refactor. Be specific about what changed.

Code style

• Python: Follow PEP 8. Use type hints for function signatures.
• R: Follow the tidyverse style guide.
• Include docstrings/comments for non-obvious logic.

Adding yourself as a contributor

When you make your first contribution to a repo, add yourself to the CONTRIBUTORS.md file in your PR.

Questions?

Open an issue or ask in the lab chat.