| 1 |
# TableBerg |
| 2 |
|
| 3 |
Advanced Table Block for Wordpress Block Editor |
| 4 |
|
| 5 |
## Project Setup |
| 6 |
|
| 7 |
You need to have `pnpm` installed on your system: https://pnpm.io/installation |
| 8 |
|
| 9 |
Install dependencies: `pnpm install`. |
| 10 |
|
| 11 |
Run project in watch mode: `pnpm start`. |
| 12 |
|
| 13 |
Build project: `pnpm build`. |
| 14 |
|
| 15 |
Export plugin zip: `pnpm export`. |
| 16 |
|
| 17 |
## Rules for contributing: |
| 18 |
|
| 19 |
### All changes must be made to the `develop` branch. |
| 20 |
|
| 21 |
* If the changes are very small (one commit), it may be pushed directly to `develop` branch. |
| 22 |
* If the changes are bigger, a new branch must be created and a pull request must be submitted. |
| 23 |
* Do not merge the branch without opening a pull request. |
| 24 |
* When a pull request has been merged, the branch should be deleted unless it's needed later. |
| 25 |
|
| 26 |
* `develop` branch will represent the next release of tableberg. |
| 27 |
|
| 28 |
### Changes should not be pushed directly to `master` branch. Instead, a pull request must be opened only from `develop` branch. |
| 29 |
|
| 30 |
* `master` branch will represent the published version of tableberg. |
| 31 |
* Before release, the blocks version (ones that have been updated) and the plugin version must be incremented. |
| 32 |
|
| 33 |
### Typescript |
| 34 |
|
| 35 |
If there are typescript errors but the changes work correctly, the changes may be pushed. Mention the typescript errors in the pr so that reviewers may try to resolve the errors before merging. |
| 36 |
|
| 37 |
If you find that you want to use a component or function from an imported package and it does not have a type signature or the type signature is incorrect, please add the type to a file in the typedefs directory. The filename should match the package name. If you're unsure what the type should be, or have any other questions regarding this process, please create an issue with the label `typescript`. |
| 38 |
|
