Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
veredcon authored Jun 10, 2024
1 parent f7eec27 commit 4e627a6
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ The initial setup is trivial:
- clone this repo
- `yarn`


### Commit Messages format.

This project enforces the [conventional-commits][conventional_commits] commit message formats.
Expand All @@ -50,8 +51,16 @@ This is normally transparent as it automatically activated in a pre-commit hook
However, this does mean that dev flows that do not use a full dev env (e.g editing directly on github)
may result in voter failures due to formatting errors.

If you get the following error regarding formatting:

![image](https://github.com/SAP/yeoman-ui/assets/9718939/0750ff0f-fe17-43f9-8fc9-8d66310828ea)

you can run `yarn format:fix`.

### Compiling

First time run `yarn ci` on the root level.

Use the following npm scripts at the repo's **root** to compile **all** the TypeScript sub-packages.

- `yarn compile`
Expand All @@ -60,6 +69,7 @@ Use the following npm scripts at the repo's **root** to compile **all** the Type
These scripts may also be available inside the sub-packages. However, it is recommended to
use the top-level compilation scripts to avoid forgetting to (re-)compile a sub-package's dependency.


#### Run the yeoman framework in dev mode

Dev mode allows you to run the yeoman framework in the browser, using vue cli for fast development cycles, and easy debug tools.
Expand Down

0 comments on commit 4e627a6

Please sign in to comment.