Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into formatter-export-fix
Browse files Browse the repository at this point in the history
  • Loading branch information
zewa666 committed Feb 7, 2024
2 parents 6a0a9ec + 8565eed commit c7002b5
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 13 deletions.
26 changes: 18 additions & 8 deletions CONTRIBUTING.md
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...
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,13 @@ pnpm run cypress
# or run it in the shell (like a CI/CD would)
pnpm run cypress:ci
```


## Sponsors

<div>
<img class="circle avatar-user" src="https://avatars.githubusercontent.com/u/48218815?s=52&amp;v=4" width="45" height="45" alt="@kevinburkett" />
<a href="/kevinburkett" class="Link">
<span class="wb-break-word ml-2">kevinburkett</span>
</a>
</div>
10 changes: 5 additions & 5 deletions packages/common/src/core/slickCore.ts
Original file line number Diff line number Diff line change
Expand Up @@ -439,15 +439,15 @@ export class SlickGroup extends SlickNonDataItem {
* @property groups
* @type {Array}
*/
groups: any[] = null as any;
groups: SlickGroup[] = null as any;

/**
* A unique key used to identify the group. This key can be used in calls to DataView
* collapseGroup() or expandGroup().
* A unique key used to identify the group.
* This key can be used in calls to DataView `collapseGroup()` or `expandGroup()`.
* @property groupingKey
* @type {Object}
*/
groupingKey = null;
groupingKey = '';

constructor() {
super();
Expand Down Expand Up @@ -508,7 +508,7 @@ export class SlickGroupTotals extends SlickNonDataItem {
* @constructor
*/
export class SlickEditorLock {
activeEditController: any = null;
activeEditController: EditController | null = null;

/**
* Returns true if a specified edit controller is active (has the edit lock).
Expand Down

0 comments on commit c7002b5

Please sign in to comment.