diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6673360..bbbd7136 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,8 @@ email, or any other method with the owners of this repository before making a ch 1. Ensure that you've tested your feature/change yourself. As the primary focus of this project is deployment, providing a link to a deployed repository using your branch is preferred. You can reference the forked action using your GitHub username, for example `yourname/github-pages-deplpy-action@master`. 2. Make sure you update the README if you've made a change that requires documentation. 3. When making a pull request, highlight any areas that may cause a breaking change so the maintainer can update the version number accordingly on the GitHub marketplace. +4. Make sure you've formatted and linted your code. You can do this by running `yarn format` and `yarn lint`. +5. Fix or add any tests where applicable. You can run `yarn test` to run the suite. # Deploying