Skip to content

Commit c08411d

Browse files
committed
docs: add contributing guide
1 parent b11f217 commit c08411d

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributing guide
2+
3+
1. Fork repository
4+
2. Switch to `master` branch
5+
3. Fix bugs or create features
6+
4. Use command `pnpm changeset` to describe what you do
7+
5. Commit with message using [Conventional commits](https://www.conventionalcommits.org/)
8+
6. Open PR!

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,8 @@ export const UserBadge = observer(({ userId }: ViewModelPayload<UserBadgeVM>) =>
9393

9494

9595
// <UserBadge payload={{ userId: '1' }}>
96-
```
96+
```
97+
98+
## Contribution Guide
99+
100+
Want to contribute ? [Follow this guide](https://github.com/js2me/mobx-tanstack-query/blob/master/CONTRIBUTING.md)

0 commit comments

Comments
 (0)