Skip to content

Commit 70ae607

Browse files
authored
docs(contributing): add CONTRIBUTING.md
1 parent 76a64df commit 70ae607

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing to `react-use-cart`
2+
3+
This library was built to be a thin layer between your product inventory + checkout.
4+
5+
Before you get started writing any code, make sure:
6+
7+
- You search open PRs and issues, someone else might be working on it
8+
- Adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) - this helps out our automated release bot
9+
- Update the `README` with any added functionality usage instructions
10+
- Add test coverage
11+
12+
## Working in development
13+
14+
This library uses [tsdx](https://tsdx.io). Execute `npm start` to start the project in development/watch mode.
15+
16+
The example directory uses the library with parcel, and you'll need to `cd example` and `npm install` to get going.
17+
18+
## PR early
19+
20+
The single most important thing you can do is PR early in `DRAFT` status. This allows maintainers, and other users to see what you're working on, and provide any suggestions early.
21+

0 commit comments

Comments
 (0)