> For the complete documentation index, see [llms.txt](https://convexity-tech-team.gitbook.io/chats-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://convexity-tech-team.gitbook.io/chats-documentation/troubleshoot/contribute.md).

# Contribute

CHATS CONTRIBUTUION GUIDE

## Convexity Humanitarian Aid Transfer Solution (CHATS) Contribution Guide

Thank you for your interest in contributing to CHATS open-source project! We appreciate your time and effort. To ensure a smooth and efficient contribution process, please follow these guidelines:

## **Fork the Repository:**

Start by forking any of our repositories on the platform [here](https://github.com/ConvexityTeam). This will create a copy of the project under your Gitlab account.

## Set Up Your Development Environment:

Clone the forked repository to your local machine using Git. Install any necessary dependencies as specified in the project's documentation. (Check the READMe)

## Create a New Branch:

Create a new branch on your local machine.

## Make Changes:

Implement your desired changes or additions to the codebase. Ensure that your code follows the project's coding conventions and style guidelines.

## Test Your Changes:

Before submitting your contribution, make sure to test your changes thoroughly. Use test frameworks (**Mocha or QUnit)** to automate the process. Once you have run the tests, you have to analyse the results. This will help you to identify any bugs or problems. If there are bugs, fix them before proceeding to commit your changes.

## Commit and Push:

Commit your changes with clear and descriptive commit messages. Push your commits to the branch you created on your forked repository.

## Create a Pull Request (PR):

Go to the original repository on GitHub and locate the "Pull Requests" section. Click on "New pull request" to create a new pull request from your branch to the original repository's main branch. Provide a descriptive title and a detailed description of your changes in the pull request.

## Contribution Approval and Merging:

Once your pull request has been reviewed and approved by the project maintainers, it will be merged into the main branch. Congratulations! Your contribution is now part of the project.

Thank you for considering contributing to our open-source project. Your contributions play a vital role in making the project successful and benefiting the CHATS community.