Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 1.75 KB
Raw

Contributing

Development Setup

You will need Node.js version 12+

  1. Fork from GitHub
  2. Clone the forked project
  3. checkout develop branch
  4. Run npm install to install dependencies.

Commits

Commit messages should follow Vue's commit message convention.

Pull Requests

  • Do not submit PRs against the main branch. Checkout a topic branch from the relevant branch (e.g. develop) and merge back against that branch
  • Work in the src folder and DO NOT check in dist in the commits
  • It's okay to have multiple small commits - GitHub will automatically squash it before merging
  • Make sure the project can be built using npm run build
  • If you are fixing a bug:
    • If you are resolving a special issue, add (fix #xxxx[,#xxxx]) (#xxxx is the issue id) in your Pull Request title.
    • Add appropriate test coverage if applicable