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

chore: Update contribution guidelines (#1326)

Browse source 
Co-authored-by: Pranav Raj S <pranav@thoughtwoot.com>
This commit is contained in:
Sojan Jose 2020-10-09 14:08:43 +05:30 committed by GitHub
parent e01fdb5f00
commit 5d5d2f9779
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
docs/contributing.md
View file

@ -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/<issue-id>-<issue-name>` (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.
- 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/<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.
### 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.