From c4076f7e149eedf1e9de03b27c16dfdd74b8191a Mon Sep 17 00:00:00 2001 From: Ghislain B Date: Tue, 19 Sep 2023 11:20:23 -0400 Subject: [PATCH] docs: improve CONTRIBUTING document --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 523efdf2..7c1e2690 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,9 @@ We'd love for you to contribute and to make this project even better than it is today! If this interests you, please make sure to follow the steps below before creating a Pull Request. -When we mention `VSCode`, we mean `Visual Studio Code` editor which can be downloaded [here](https://code.visualstudio.com) +When we mention `VSCode`, we mean the `Visual Studio Code` editor which can be downloaded [here](https://code.visualstudio.com) -Before accepting any Pull Request, we need to make sure that you followed these steps: +Before accepting any Pull Request, we would you like to remind you to follow these steps: 1. Install dependencies ```sh npm install @@ -13,6 +13,6 @@ npm install ```sh npm run build:prod ``` -3. Fix any Lint or TypeScript issues (if any) -4. If you did step 2 and 3, then the final step would be go ahead with the Pull Request - - **Note** even though the `dist/` folder is included in Git, you could choose to ignore these files from the Pull Request. \ No newline at end of file +3. Fix any Linting or TypeScript issues (if any) returned by the build process +4. After being done with step 2 and 3, then the final step would be to proceed with your Pull Request + - **NOTE** even though the `dist/` folder is included in Git for portability, you could choose (we stringly recommend) that you ignore/disregard these files from being included in your Pull Request.