2019-10-09 12:25:33 +00:00
---
path: "/docs/contributing-guide"
title: "Contributing Guide"
---
2019-10-02 10:06:47 +00:00
2020-02-07 06:35:09 +00:00
Thank you for taking an interest in contributing to Chatwoot. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
2019-10-02 10:06:47 +00:00
2019-10-13 04:28:32 +00:00
- [Code of Conduct ](https://www.chatwoot.com/docs/code-of-conduct )
2019-11-18 16:35:10 +00:00
- [Development Setup ](https://www.chatwoot.com/docs/installation-guide-ubuntu )
2019-11-23 20:31:13 +00:00
- [Environment Setup ](https://www.chatwoot.com/docs/quick-setup )
2019-10-02 10:06:47 +00:00
## Pull Request Guidelines
2020-10-09 08:38:43 +00:00
### General Guidelines
2020-01-20 18:03:29 +00:00
2020-10-09 08:38:43 +00:00
- We use [git-flow ](https://nvie.com/posts/a-successful-git-branching-model/ ) branching model. The base branch is `develop`
2019-10-02 10:06:47 +00:00
2020-10-09 08:38:43 +00:00
- Please raise your PRs against `develop` branch
2019-10-02 10:06:47 +00:00
2020-02-07 06:35:09 +00:00
- It's okay and encouraged to have multiple small commits as you work on the PR - we will squash the commits before merging.
2019-10-02 10:06:47 +00:00
2020-11-18 09:57:50 +00:00
### Getting Started
2020-10-09 08:38:43 +00:00
- Before starting your work, ensure an [issue ](https://github.com/chatwoot/chatwoot/issues ) exist for it. If not feel free to create one.
2020-11-18 09:57:50 +00:00
- Add a comment on the issue and wait for the issue to be assigned before you start working on it.
- This helps to avoid multiple people working on similar issues.
- If the solution is complex, propose the solution on the issue and wait for one of the core contributors to approve before going into the implementation.
2020-10-09 08:38:43 +00:00
- This helps in shorter turn around times in merging PRs
2020-11-18 09:57:50 +00:00
- For new feature requests, Provide a convincing reason to add this feature. Real-life business use-cases will be super helpful.
- Feel free to join our [discord community ](https://discord.gg/cJXdrwS ), if you need further discussions with the core team.
2020-10-09 08:38:43 +00:00
### Developing a new feature:
- Please create the branch in the format `feature/<issue-id>-<issue-name>` (eg: `feature/235-contact-panel` )
- Add accompanying test cases.
### Bug fixes or chores:
- If you are resolving a particular issue, add `Bug: Fix xxxx` (#xxxx is the issue) in your PR title.
- Provide a detailed description of the bug in the PR.
- Add appropriate test coverage if applicable.
2020-11-18 09:57:50 +00:00
### Translations
For language translations, please read the guide [translating Chatwoot to your language ](/docs/contributing/translating-chatwoot-to-your-language )
