Files
deploy-pages/CONTRIBUTING.md

30 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2023-04-13 23:01:41 +01:00
# Contributing 💻
All contributions are welcome and greatly appreciated!
## Steps to Contribute 💡
> 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
2023-04-17 23:51:13 -05:00
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
2023-04-17 23:51:57 -05:00
7. Wait for an approval or changes requested from the maintainers of this repository
2023-04-13 23:01:41 +01:00
2023-04-17 23:51:13 -05:00
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!
2023-04-13 23:01:41 +01:00
## Testing 🧪
### Running the test suite (required)
Simply run the following command to execute the entire test suite:
```bash
2023-04-17 23:51:13 -05:00
npm test
2023-04-13 23:01:41 +01:00
```
2023-04-17 23:51:13 -05:00
> Note: This requires that you have already run `npm install`.