scottk/chatwoot
1
0
Fork 0
mirror of https://github.com/lingble/chatwoot.git synced 2025-10-31 02:57:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ec197b077d6da658e21ea16f1e152da25c7c8f86
chatwoot/docs/contributing.md
Vishnu Narayanan 3eb5b3a0c1 docs: Update contribution guidelines (#471) (#474)
2020-02-07 12:05:09 +05:30

1.4 KiB
Raw Blame History

path, title
path title
/docs/contributing-guide Contributing Guide

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:

Pull Request Guidelines

  • We use git-flow branching model. The base branch is develop.

  • Comment on an issue before you start work on it. This helps to avoid multiple people working on similar issues.

  • Please raise the PR 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.

  • 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.