diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c12b87b..2ae03d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,13 +7,14 @@ All contributions are welcome and greatly appreciated! > Check the `.node-version` file in the root of this repo so see what version of Node.js is required for local development - note, this can be different from the version of Node.js which runs the Action on GitHub runners. It is suggested to download [nodenv](https://github.com/nodenv/nodenv) which uses this file and manages your Node.js versions for you 1. Fork this repository -2. Commit your changes -3. Test your changes (learn how to test below) -4. Open a pull request back to this repository -5. Notify the maintainers of this repository for peer review and approval -6. Merge! +2. Make your changes +3. [Test](#testing-) your changes locally +4. Before opening a pull request, please run `npm run all` to verify formatting, linting, tests, generated files, etc. +5. Commit and push your changes to your fork +6. Open a pull request back to this repository +7. Await for an approval or changed requested from the maintainers of this repository -The maintainers of this repository will create a new release with your changes so that everyone can use the new release and enjoy the awesome features of this Action! +After merging the pull request, the maintainers of this repository will create a new release with those changes included. After that, everyone can utilize the newly integrated changes in their own Actions workflows and enjoy your awesome improvements! ## Testing 🧪 @@ -22,7 +23,7 @@ The maintainers of this repository will create a new release with your changes s Simply run the following command to execute the entire test suite: ```bash -npm run test +npm test ``` -> Note: this requires that you have already run `npm install` +> Note: This requires that you have already run `npm install`.