KumiSystems/Chatwoot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update contributing.md (#434)

Browse source
This commit is contained in:
Pranav Raj S 2020-01-20 23:48:29 +05:45 committed by Sojan Jose
parent 9290893f9d
commit 90e678743b
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/contributing.md
View file

@ -11,17 +11,20 @@ Thanks for taking interest in contributing to Chatwoot source code. Before submi
## Pull Request Guidelines ## 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) - 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. - 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: - If adding a new feature:
- Please create the branch in the format `feature/<issue-id>-<issue-name>` (eg: `feature/235-contact-panel`)
- Add accompanying test case. - 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. - 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 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. - Provide a detailed description of the bug in the PR.
- Add appropriate test coverage if applicable. - Add appropriate test coverage if applicable.