mirror of
https://github.com/SomboChea/ui
synced 2024-11-11 00:54:26 +07:00
chore: add some extra notes to readme
This commit is contained in:
parent
48c03fe472
commit
7de6983d1e
16
README.md
16
README.md
@ -33,6 +33,12 @@ The configuration file is located on `tools/_config.yaml`.
|
|||||||
|
|
||||||
Run linting tooling and test to check your code is clean before commit.
|
Run linting tooling and test to check your code is clean before commit.
|
||||||
|
|
||||||
|
> ⚠️ The development mode just emulate interaction of the UI development with a real verdaccio server, but it is not the real integration. UI is just a theme plugin dependency in the [Verdaccio project](https://github.com/verdaccio/verdaccio).
|
||||||
|
|
||||||
|
### Before commit
|
||||||
|
|
||||||
|
Don't forget run the following commands before commit and push your code, it will save you time.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn lint && yarn test
|
yarn lint && yarn test
|
||||||
```
|
```
|
||||||
@ -41,6 +47,16 @@ Remember we follow the [the Conventional Commits specification](https://www.conv
|
|||||||
|
|
||||||
🤓 Feel free to participate in code reviews, let us know if you want to participate in this plugin.
|
🤓 Feel free to participate in code reviews, let us know if you want to participate in this plugin.
|
||||||
|
|
||||||
|
### End to End Testing
|
||||||
|
|
||||||
|
Additionally, we recommend run E2E testing before push and verify your changes do not break anything. These command will run in our CI anyway.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn build && yarn test:e2e
|
||||||
|
```
|
||||||
|
|
||||||
|
> `yarn build` will build with webpack the production files.
|
||||||
|
|
||||||
|
|
||||||
## Open Collective Sponsors
|
## Open Collective Sponsors
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user