Skip to content

Latest commit

 

History

History
29 lines (15 loc) · 1.13 KB

contributing.md

File metadata and controls

29 lines (15 loc) · 1.13 KB
Raw

vue-persian-tools Contributing Guide

Hi! We're really excited that you are interested in contributing to vue persian tools. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

Pull Request Guidelines

  • The master branch is 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 relevant branch, e.g. dev, and merge back against that branch.

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

  • If adding a new feature:

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

    • Provide a detailed description of the bug in the PR. Live demo preferred.

  • It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.

  • Follow Conventional commit

  • Make sure tests pass!