Hello! I am very excited that you are interested in contributing with Vuesax. However, before submitting your contribution, be sure to take a moment and read the following guidelines.
- The masterrama is basically a snapshot of the latest stable version. All development must be done in dedicated branches.
- Work in the src folder and DO NOT register distlos commits.
- It is good to have multiple small commits while working on the PR. We'll let GitHub squash it automatically before the merge.
- If you add a new feature: - Add the test case that accompanies it. - Provide a compelling reason to add this feature. Ideally, I would first open a suggestion topic and green it before working on it.
- If you correct an error: - If you are solving a special problem, add (fix #xxxx [, # xxx]) (# xxxx is the problem identification) in your PR title for a better launch record, for example update entities encoding / decoding (fix # 3899). - Provide a detailed description of the error in the PR. Favorite live demo. - Add the appropriate test coverage, if applicable.
- You will need Node.js version 6+.
- You will need Vuepress installed globally.
After cloning the repository, execute:
npm install
# Start the test server and the documentation
npm run dev