First, thanks for being willing to contribute!
- Fork and clone this repo
- Run
yarn install
to install all dependencies (we require yarn instead of any other JS package manager) - Create a branch for your PR with
git checkout -b your-branch-name
鈩癸笍 Credit: From [React Testing Library][react-testing-lib]
Tip: Keep yourmain
branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:git remote add upstream https://github.com/alexanderkhivrych/use-modal-hook git fetch upstream git branch --set-upstream-to=upstream/main main
This will add the original repository as a "remote" called "upstream", then fetch the git information from that remote and set your local
main
branch to use the upstream main branch whenever you rungit pull
. You can now make all of your pull request branches based on thismain
branch. Whenever you want to update your version ofmain
, do a regulargit pull
.
- Commit messages follow the Conventional Commit spec;
- Code styling is enforced via ESLint and Prettier.
Our CI setup, using Github Actions, will also check these standards before contributions can be merged.
Please checkout the the open issues.