Skip to content

Latest commit

 

History

History
105 lines (66 loc) · 4.18 KB

CONTRIBUTING.md

File metadata and controls

105 lines (66 loc) · 4.18 KB
Raw

Contribution Guidelines

First of all, thanks for thinking of contributing to this project! 👏

Contributions are welcome and will be fully credited.

Code of conduct

This project has a Contributor Covenant Code of Conduct. By participating in this project you agree to abide by its terms.

❤ Ways to Contribute

  • Blog or tweet about the project
  • Improve documentation
  • Fix a bug
  • Implement a new feature
  • Discuss potential ways to improve project
  • Improve existing implementation, performance, etc.

🛎 Questions

Feel free to open a ticket with your question.

Please put some effort in requesting a new feature. If someone else is going to implement something, the least you can do is describe the feature in detail, and why it would be useful to others as well.

🐛 File a Bug

In case you've encountered a bug, please make sure:

  • You are using the latest version.
  • You have read the documentation first, and double-checked your configuration.
  • You have acknowledged from --verbose and --debug the errors are likely a bug in this project (and not coming from your environment or a dependency of this project).
  • In your issue description, please include:
    • What you expected to see, and what happened instead.
    • Your operating system and other environment information by running info.
    • As much information as possible, such as the command and configuration used.
    • Interesting logs with --verbose and/or --debug.
    • All steps to reproduce the issue.

🎁 Pull Requests

We accept contributions via Pull Requests on Github.

Please keep the following in mind:

  • See below for instructions on how to set up the project on your machine.
  • To match the existing code styling, use npm run prettier before committing code.
  • Make sure the tests pass (run npm test). Your changes probably deserve new tests as well.
  • Remember that this project is cross-platform compatible (macOS, Windows, Linux), and that it runs in different versions of Node.

Unsure about whether you should open a pull request? Feel free to discuss it first in a ticket.

Somethings to keep in mind

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

    Tip: To pass lint tests easier use the npm run lint:fix command.

  • Add tests! - Your contribution will not be accepted if it does not have accompanying tests.

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

  • Consider our release cycle - We follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • Create feature branches - Don't ask us to pull from your master branch. Always create a separate branch for any change.

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

  • Send coherent history - We follow Conventional Commits standard for commit message and use tooling to simplify conforming with and enforcing the standard. Ensure you provide meaning full commit messages! Use the tooling that the project provides.

    Tip: To commit use the npm run commit command, this is an interactive commit command that ensures that the commit complies with the Conventional Commits standard.

Set up the project on your machine

First fork the the project on GitHub. Learn all about forking a repo here. More information on cloning a repo here.

git clone https://github.com/nidkil/vuetify-with-storybook
cd vuetify-with-storybook
npm install

Verify the tests are passing:

npm test

Lint the project:

npm run lint

To make vuetify-with-storybook globally available so you can run it on your (test) project(s):

npm link

Happy coding!

License

Released under the MIT license.