Contributing to CaML

Welcome to the CaML contributor guide!

We manage out project via Github and leverage Github Flow for managing our development process. This guide will help you get started as a contributor and guide you through the process of contributing to CaML.

General Contribution Guide

Pull requests are the best way to make changes to CaML:

  1. Fork the repo and create your branch from main branch
  2. Clone the repository
  3. For environment setup, see Environment Setup
  4. For documentation, see Documentation
  5. For testing, see Testing
  6. Create a pull request & fill out the generated PR template

CaML follows conventional commits for our PR titles, see here for more details.

All github actions & checks will be required to complete successfully prior to merging.

Report Bugs using Github Issues

Bugs, features, and any other feedback can be submitted using the Github issues page.

Back to top