Skip to content

Commit 23ebbbd

Browse files
committed
add CONTRIBUTING.md
1 parent cb16bab commit 23ebbbd

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
## Issues
4+
5+
Please provide a minimal, reproducible test-case.
6+
7+
8+
## Pull Requests
9+
10+
Follow the instructions on the Pull Request Template (shown when you open a new PR) and make sure you've done the following:
11+
12+
- [ ] Add & update tests
13+
- [ ] Ensure CI is passing (lint, tests)
14+
- [ ] Update relevant documentation and/or examples
15+
16+
17+
## Setup
18+
19+
This package uses [yarn](https://yarnpkg.com) for development dependency management. Ensure you have it installed before continuing.
20+
21+
```sh
22+
yarn
23+
```
24+
25+
## Running Tests
26+
27+
```sh
28+
yarn test
29+
```
30+
31+
32+
## Building
33+
34+
```sh
35+
yarn build
36+
```

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' });
5353
/* returns 'foo=bar&baz=qux&baz=quux&corge=' */
5454
```
5555

56+
## Contributing
57+
58+
[Contributing](/CONTRIBUTING.md)
59+
5660

5761
## License
5862

0 commit comments

Comments
 (0)