Contributing code and documentation

If you’re ready to start contributing and have experience, please jump in! We have a quick start guide below.

If you’ve never contributed to the CHT before, please see our First time Contributors Guide

Quick Start

Code

Before you start coding a new change you suggest to the CHT, raise an issue or start a conversation about the change you want to make. Then:

1. Read the CHT Development Workflow and Code Style Guide
2. Find a good ticket and request it be assigned to you via a comment.
3. Setup your development environment
4. Make sure your pull request’s (PR) tests all pass. Failures need to be addressed before we can merge your code.
5. Provide detail about the issue you are solving on the PR. Please reference any existing issues using medic/#
6. Our CI will automatically schedule a build; monitor the build to ensure it passes.
7. Your PR will be reviewed by a maintainer. Expect at least one change requested - don’t be offended if your change doesn’t get accepted on the first try!

Docs

Help us maintain the quality of the CHT documentation by submitting a PR with any suggested changes. See the Documentation Style Guide, then open a pull request with your suggested changes or additions. For simple changes, use the “Edit this page” link shown in the upper right of every page.