Skip to content

Commit d01866c

Browse files
Merge pull request #41 from zeixcom/feature/readme
docs: new README
2 parents 5a23ef4 + 38f392b commit d01866c

File tree

3 files changed

+224
-263
lines changed

3 files changed

+224
-263
lines changed

CONTRIBUTING.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,13 @@ bun install
7676
**Run tests in watch mode:**
7777

7878
```sh
79-
bun run watch
79+
bun run test:watch
8080
```
8181

8282
**Build the project:**
8383

8484
```sh
8585
bun run build
86-
bun run build:dev
8786
```
8887

8988
**Start a development server for docs:**
@@ -102,7 +101,7 @@ To maintain a high-quality codebase, please follow these guidelines:
102101
* Avoid unnecessary dependencies.
103102
* Use functional programming principles where applicable.
104103
* Prefer composition over inheritance.
105-
* Make sure to lint your code (`bun run lint`) and all tests pass (`bun run watch`).
104+
* Make sure to lint your code (`bun run lint`) and all tests pass (`bun run test:watch`).
106105

107106
## Commit Message Guidelines
108107

0 commit comments

Comments
 (0)