Hi! We're really excited that you are interested in contributing to Vuex. Before submitting your contribution, please make sure to take a moment and read through the following 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:
If fixing bug:
(fix #xxxx[,#xxxx])
(#xxxx is the issue id) in your PR title for a better release log, e.g. update state re-evaluation (fix #3899)
.It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
Make sure tests pass!
Commit messages must follow the commit message convention so that changelogs can be automatically generated.