Skip to content

Commit

Permalink
docs: Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shhdharmen authored Apr 21, 2024
1 parent 93a0151 commit 6592466
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ npm start

## Testing

### Run unit tests
### Run cypress tests

```bash
npm start
Expand All @@ -27,17 +27,10 @@ npm run unit

Cypress window will open, you can click on individual tests.

### Run e2e tests (generally run in CI)

```bash
npm run build -- --prod
npm run e2e
```

## Building

```bash
npm run build
npm run build:lib
```

## <a name="rules"></a> Coding Rules
Expand All @@ -49,11 +42,21 @@ To ensure consistency throughout the source code, keep these rules in mind as yo

## <a name="commit"></a> Commit Message Guidelines

### TL;DR

Simply run commit script after staging your files to take care about commit message guidelines

```bash
npm run commit
```

### Details

We have very precise rules over how our git commit messages can be formatted. This leads to **more
readable messages** that are easy to follow when looking through the **project history**. But also,
we use the git commit messages to **generate the Hot-toast changelog**.

### Commit Message Format
#### Commit Message Format

Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
format that includes a **type**, a **scope** and a **subject**:
Expand Down

0 comments on commit 6592466

Please sign in to comment.