Skip to content

Latest commit

 

History

History
64 lines (39 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

64 lines (39 loc) · 2.35 KB
Raw

Contributing ✨

Thank you for your interest in contributing to this project! Any contribution is welcome and invited! 🙌

If you are proposing a new feature, make sure to open an issue to make sure it is inline with the project goals.

Setup 🧑‍💻

  1. Fork this repository to your own GitHub account and clone the development branch to your local device:

    git clone -b develop https://github.com/Norgate-AV-Solutions-Ltd/react-crestron-ch5-hooks.git
cd react-crestron-ch5-hooks

  2. Install the dependencies and build:

    pnpm install && pnpm build

    Note: you'll need to run pnpm build any time you want to see your changes, or run pnpm start to leave it in watch mode.

  3. Create a new branch and start working on it:

    git checkout -b my-feature

  4. Commit your changes:

    git commit -m "feat(my-feature): my feature description"

Conventional Commits 📝

Conventional Commits

This project enforces the Conventional Commits format for commits. If in doubt, you can use the pnpm commit command to commit your changes. This will run the Commitizen CLI and walk you through a series of prompts to fill out the commit message in the correct format.

Submitting a Pull Request 🚀

Be sure to run pnpm test before you create your Pull Request to make sure you haven't broken anything.

Add yourself as a Contributor 🙋‍♂️

This project follows the all-contributors specification. Contribution types are listed in the emoji key.

You can add yourself in one of two ways:

  1. Comment on the Pull Request, asking the @all-contributors bot to add you to the contributors list.

    @all-contributors please add @<username> for <contributions>

    or

  2. Run the pnpm contrib:add command to add yourself to the contributors list.

    pnpm contrib:add <username> <contribution>,<contribution>,...