-
-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master' into formatter-export-fix
- Loading branch information
Showing
3 changed files
with
33 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,22 @@ | ||
# Contributing | ||
|
||
We'd love for you to contribute and to make this project even better than it is today! If this interests you, please begin by reading the project [Wiki documentation](https://github.com/ghiscoding/slickgrid-universal/wiki). Once you consulted them and you believe that you can help us with new features, improvement or even fixes then go ahead and submit a Pull Request. | ||
We'd love for you to contribute and to make this project even better than it is today! If this interests you, please start by consulting the project [Documentation](https://ghiscoding.gitbook.io/slickgrid-universal/) website. Once that is done and you believe that you can help us with new features, improvement or even fixes then go ahead and submit a Pull Request. | ||
|
||
When we mention `VSCode`, we mean `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 the step shown below. | ||
|
||
Before accepting any Pull Request, we need to make sure that you followed these steps: | ||
1. Install [pnpm](https://pnpm.io/installation) globally or run it through `npx pnpm` since it is used in all `package.json` scripts and VSCode Tasks if you want to use them. | ||
2. Have you tested all your changes with Jest? | ||
3. Have you run the TypeScript Build? | ||
- you can run the build with `pnpm run build` from the root of the project | ||
4. If you did step 2 and 3, then the final step would be the Pull Request... but wait! For readability purposes, we would like you to only submit the relevant pieces of code that you changed. We are basically asking you to do a Build and make sure there's no errors (Yes please) but to not include the produced `dist` folder. We just want to see the real changes, nothing else (but we still want to make sure it Builds before creating a PR). | ||
_When we mention `VSCode`, we mean `Visual Studio Code` editor which can be downloaded [here](https://code.visualstudio.com)_ | ||
|
||
### Steps | ||
|
||
1. clone the lib: | ||
- `git clone https://github.com/ghiscoding/slickgrid-universal/` | ||
2. install with **pnpm** from the root: | ||
- `pnpm install` OR `npx pnpm install` | ||
3. run Linter script (or simply execute step 5.) | ||
- `pnpm lint` | ||
4. run a full TypeScript (TSC) build (this will also run Biome Lint & Format) | ||
- `pnpm build` OR `npx pnpm build` | ||
5. add/run Vitest unit tests (make sure to run the previous steps first): | ||
- `pnpm test` (watch mode) | ||
- `pnpm test:coverage` (full test coverage) | ||
6. after achieving step 2 to 5, then the final step would be to create the Pull Request... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters