Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 1.64 KB

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on Github.

Pull Requests

  • New Features - Make sure your feature is something that have been discussed in an issue before or that is on the roadmap

  • Bug fixes - YES, please!!

  • Keep the same style - eslint will automatically be ran before committing

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • Create feature branches - Don't ask us to pull from your master branch.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - Make sure your commits message means something. If you like emojis, feel free to add one at the beginning of the commit to better reflect the nature of the commit 😄

Debugging

To debug the template you should clone it and work locally on the template or a project generated with it. Then use the vue-cli to test it locally:

# At ~
vue init ./vue-plugin-template testing-dir

Make sure to prefix the template name with ./ or another character to indicate you're using a local template.

Sometimes it's simpler to work on the generated project and port back any modifications to the template.

Templates are rendered with Handlebars.

You can find more help about creating templates on the vue-cli README

Happy coding!