File tree Expand file tree Collapse file tree 1 file changed +43
-0
lines changed Expand file tree Collapse file tree 1 file changed +43
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing
2
+
3
+ Thanks for wanting to make contribution and wanting to improve this library for everyone!
4
+
5
+ ## Project setup
6
+
7
+ 1 . Fork and clone the repo
8
+ 2 . Run ` npm install ` to install dependencies
9
+ 3 . Create a branch for your PR with ` git checkout -b pr/your-branch-name `
10
+
11
+ ## Add yourself as a contributor
12
+
13
+ This project follows the [ all contributors] ( https://github.com/kentcdodds/all-contributors ) specification. To
14
+ add yourself to the table of contributors on the ` README.md ` , please use the
15
+ automated script as part of your PR:
16
+
17
+ ``` console
18
+ npm run contributors:add
19
+ ```
20
+
21
+ Follow the prompt and commit ` .all-contributorsrc ` and ` README.md ` in the PR. If
22
+ you've already added yourself to the list and are making a new type of
23
+ contribution, you can run it again and select the added contribution type.
24
+
25
+ ## Committing and Pushing changes
26
+
27
+ Please make sure to run the tests before you commit your changes. You can do so by running
28
+ ` npm test ` .
29
+
30
+ ### Add typings
31
+
32
+ If your PR introduced some changes in the API, you are more than welcome to
33
+ modify the Typescript type definition to reflect those changes. Just modify the
34
+ ` index.d.ts ` file accordingly. If you have never seen Typescript
35
+ definitions before, you can read more about it in its
36
+ [ documentation pages] ( https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html )
37
+
38
+ ## Help needed
39
+
40
+ Please checkout the [ the open issues] ( https://github.com/mpeyper/react-hooks-testing-library/issues )
41
+
42
+ Also, please watch the repo and respond to questions/bug reports/feature
43
+ requests! Thanks!
You can’t perform that action at this time.
0 commit comments