Skip to content

Commit 858e300

Browse files
Add CONTRIBUTING.md
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 199d2e5 commit 858e300

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing
2+
3+
Contributions are welcome! Here's how to get started.
4+
5+
## Setup
6+
7+
```bash
8+
git clone https://github.com/ofershap/deep-diff-ts.git
9+
cd deep-diff-ts
10+
npm install
11+
```
12+
13+
## Development
14+
15+
```bash
16+
npm run build # Build with tsup
17+
npm run typecheck # Type-check with tsc
18+
npm test # Run tests
19+
npm run test:watch # Run tests in watch mode
20+
npm run lint # Lint + format check
21+
npm run format # Auto-format with Prettier
22+
```
23+
24+
## Pull Requests
25+
26+
1. Fork the repo and create a branch from `main`
27+
2. Make your changes
28+
3. Add or update tests as needed
29+
4. Ensure `npm run lint`, `npm run typecheck`, and `npm test` all pass
30+
5. Open a pull request
31+
32+
## Commit Messages
33+
34+
This project uses [Conventional Commits](https://www.conventionalcommits.org/) and [semantic-release](https://github.com/semantic-release/semantic-release) for automated versioning. Please format your commit messages accordingly:
35+
36+
- `feat: add new feature` (triggers minor release)
37+
- `fix: resolve bug` (triggers patch release)
38+
- `feat!: breaking change` (triggers major release)

0 commit comments

Comments
 (0)