Skip to content

Commit

Permalink
docs: improve CONTRIBUTING document
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiscoding authored Sep 19, 2023
1 parent 1bbe40e commit c4076f7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
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.

0 comments on commit c4076f7

Please sign in to comment.