Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 1.01 KB

contributing.md

File metadata and controls

18 lines (11 loc) · 1.01 KB

Devcomm Contributing Guide

Hi! Thank you for choosing to contribute to Devcomm. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.

Pull Request Guidelines

  • The master branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branches. Do not submit PRs against the master branch.

  • Checkout a topic branch from the dev branch, and merge back against that branch.

  • It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.

  • If adding new feature:

    • Ideally you should open a suggestion issue first and have it greenlighted before working on it.

  • If fixing a bug:

    • If you are resolving a special issue, add (fix #xxxx[,#xxx]) (#xxxx is the issue id) in your PR title for a better release log, e.g. update entities encoding/decoding (fix #3899).
    • Provide detailed description of the bug in the PR. Live demo preferred.