Skip to content

Commit

Permalink
docs: update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
shhdharmen committed Apr 21, 2024
1 parent 72ebcb4 commit 76372ef
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 15 deletions.
32 changes: 19 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Cmdk
# Contributing to CMDK

🙏 We would ❤️ for you to contribute to Cmdk and help make it even better than it is today!
🙏 We would ❤️ for you to contribute to cmdk and help make it even better than it is today!

## Developing

Expand All @@ -10,19 +10,23 @@ Start by installing all dependencies:
npm i
```

Run the tests:
Run the playground app:

```bash
npm test
npm run e2e
npm start
```

Run the playground app:
## Testing

### Run cypress tests

```bash
npm start
npm run unit
```

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

## Building

```bash
Expand All @@ -38,19 +42,21 @@ To ensure consistency throughout the source code, keep these rules in mind as yo

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

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 Cmdk changelog**.

### Through CLI
### TL;DR

Simply run below command to take of all the rules:
Simply run commit script after staging your files to take care about commit message guidelines

```bash
npm run commit
```

### Commit Message Format
### 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 cmdk changelog**.

#### 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
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
"start": "ng serve",
"build": "ng build --base-href=/cmdk/",
"watch": "ng build --watch --configuration development",
"test": "ng test",
"contributors:add": "all-contributors add",
"hooks:pre-commit": "node hooks/pre-commit.js",
"commit": "cz",
Expand All @@ -17,7 +16,9 @@
"test:lib:headless": "cross-env CI=true npm run test:lib",
"postbuild:lib": "npm run build --prefix projects/ngxpert/cmdk",
"semantic-release": "semantic-release",
"lint": "ng lint"
"lint": "ng lint",
"unit": "npm run cy:open",
"cy:open": "cypress open"
},
"private": true,
"dependencies": {
Expand Down

0 comments on commit 76372ef

Please sign in to comment.