From d3d45b5f5bfe8b61808f0f00e994073150821529 Mon Sep 17 00:00:00 2001 From: Kitty Chiu <42864823+KittyChiu@users.noreply.github.com> Date: Wed, 21 Feb 2024 10:18:56 +1100 Subject: [PATCH] fix --- CONTRIBUTING.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5968ea5..0090c01 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,30 +16,30 @@ Before you start contributing, please make sure that you have read the 1. Make sure your local clone pass build and test with - ```bash - npm install - npm run bundle - npm test - ``` - +```bash +npm install +npm run bundle +npm test +``` + 1. Make your changes. Add\update tests under `\test`. Update the documentation as required 1. Before committing, validate the format, test, and build the action - ```bash - npm run all - ``` - - > [!WARNING] - > - > This step is important! It will run - > [`vercel/ncc`](https://github.com/vercel/ncc) to build the final JavaScript - > action code with all dependencies included. If you do not run this step, the - > action will not work correctly when it is used in a workflow. This step also - > includes the `--license` option for `ncc`, which will create a license file - > for all of the production node modules used in the action. - +```bash +npm run all +``` + +> [!WARNING] +> +> This step is important! It will run +> [`vercel/ncc`](https://github.com/vercel/ncc) to build the final JavaScript +> action code with all dependencies included. If you do not run this step, the +> action will not work correctly when it is used in a workflow. This step also +> includes the `--license` option for `ncc`, which will create a license file +> for all of the production node modules used in the action. + 1. Push your changes to your forked repository on GitHub. 1. Create a pull request against `main` and get feedback on your changes.