Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (18 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

35 lines (18 loc) · 1.19 KB

Mark Text Contributing Guide

Hi, I'm really excited that you are interested in contributing to Mark Text. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.

Issue Reporting Guidelines

Always follow the Issue template

Pull Request Guidelines

  • Submit the PRs directly to the master branch.

  • Work in the src folder and DO NOT checkin dist in commits.

  • If you adding new feature:

    • Open a suggestion issue first and add appropriate label to it.

    • Provide convincing reason to add this feature.

    • Then submit you PRs.

  • If fixing a bug:

    • 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 or picture preferred.

  • All PRs need to pass the Travis Ci before merged.