Skip to content

Latest commit

聽

History

History
56 lines (38 loc) 路 2.25 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) 路 2.25 KB
Raw

Contributing

Thanks for being willing to contribute!

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Project setup

You're going to need git to get the project, and node and yarn to install dependencies and run scripts.

  1. Fork and clone the repo
  2. Run yarn to install dependencies
  3. Run yarn test for testing
  4. Run yarn lint for linting
  5. Run yarn start to compile
  6. Run yarn docs to test the directive using the example project
  7. Create a branch for your PR

Add yourself as a contributor

This project follows the all contributors specification. To add yourself to the table of contributors on the README.md, please use the automated script as part of your PR:

yarn add-contributor <YOUR_GITHUB_USERNAME>

Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run it again and select the added contribution type.

Committing and Pushing changes

This project uses semantic-release to do automatic releases and generate a changelog based on the commit history. So we follow a convention for commit messages. Please follow this convention for your commit messages.

You can use commitizen to help you to follow the convention

Once you are ready to commit the changes, please use the below commands

  1. Run git add <files to be comitted> to stage changed files
  2. Run yarn commit to start commitizen to commit those files

... and follow the instruction of the interactive prompt.

Help needed

Please checkout the issues! Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!