Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.23 KB
Raw

Semantic Versioning

vue-client-only use SemVer for versioning.

Sending a Pull Request

Before submitting a pull request, please make sure the following is done:

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add tests!
  3. If you've changed APIs, update the documentation.
  4. Format your code.

Development Workflow

After cloning vue-client-only, run yarn to fetch its dependencies. Then, you can run several commands:

  • yarn dev will build module of vue-client-only to the dist folder and watch for changes.
  • cd dev move to dev folder to test the package.
  • yarn install dependencies of dev folder. (Only need to run once)
  • yarn dev to start dev server of the dev project, then test the package
  • yarn build creates the module of vue-client-only in the dist folder.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgement

This CONTRIBUTING.md is based on the react how-to-contribute.md file.