From 90e678743bec6b8b1e80ab2d4a5df72aae881848 Mon Sep 17 00:00:00 2001 From: Pranav Raj S Date: Mon, 20 Jan 2020 23:48:29 +0545 Subject: [PATCH] Update contributing.md (#434) --- docs/contributing.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 4370fea14..7666a66e8 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -11,17 +11,20 @@ Thanks for taking interest in contributing to Chatwoot source code. Before submi ## Pull Request Guidelines +- We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model. The base branch is develop. + - Assign the corresponding issue to you whenever you start working on it. This helps in resolving collision (mutliple people working on the same item) -- Please raise the PR against master branch +- Please raise the PR against `develop` branch - It's OK 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. - If fixing bug: - - If you are resolving a special issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title. + - 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.