From 5d5d2f97796b12dc4bc6d14f22d50eed05ea2bce Mon Sep 17 00:00:00 2001 From: Sojan Jose Date: Fri, 9 Oct 2020 14:08:43 +0530 Subject: [PATCH] chore: Update contribution guidelines (#1326) Co-authored-by: Pranav Raj S --- docs/contributing.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index dc5a9b3a7..aa7a00df2 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -11,20 +11,36 @@ Thank you for taking an interest in contributing to Chatwoot. Before submitting ## Pull Request Guidelines -- We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model. The base branch is develop. +### General Guidelines -- Comment on an issue before you start work on it. This helps to avoid multiple people working on similar issues. +- We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model. The base branch is `develop` -- Please raise the PR against `develop` branch +- Please raise your PRs against `develop` branch - It's okay and encouraged to have multiple small commits as you work on the PR - we will squash the commits before merging. -- If adding a new feature: - - Please create the branch in the format `feature/-` (eg: `feature/235-contact-panel`) - - Add accompanying test case. - - Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it. +### Getting Started -- If fixing bug: - - If you are resolving a special 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. +- Before starting your work, ensure an [issue](https://github.com/chatwoot/chatwoot/issues) exist for it. If not feel free to create one. +- 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. + - This helps in shorter turn around times in merging PRs +- 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. + +### Developing a new feature: + +- Please create the branch in the format `feature/-` (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. + +### Translations: +- When you are introducing new text copies, you only need to worry about making changes to english language files. +- We accept language translations / updates for existing translations through [crowdin](https://translate.chatwoot.com/) + - If a language doesn't exist in our crowdin, please feel free to create an [issue](https://github.com/chatwoot/chatwoot/issues) to get it enabled. +