Skip to content

Commit 43f7cf4

Browse files
authored
Create CONTRIBUTING.md
1 parent 21b2704 commit 43f7cf4

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing to json-base
2+
I love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3+
4+
- Reporting a bug
5+
- Discussing the current state of the code
6+
- Submitting a fix
7+
- Proposing new features
8+
- Becoming a maintainer
9+
10+
11+
I actively welcome your pull requests:
12+
13+
1. Fork the repo and create your branch from `main`.
14+
2. If you've added code that should be tested, add tests.
15+
3. If you've changed APIs, update the documentation.
16+
4. Ensure the test suite passes.
17+
5. Make sure your code lints.
18+
6. Issue that pull request!
19+
20+
21+
#### Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
22+
23+
I use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/ndzhwr/json-base/issues/new); it's that easy!
24+
25+
#### Write bug reports with detail, background, and sample code
26+
27+
- A quick summary and/or background
28+
- Steps to reproduce
29+
- Be specific!
30+
- Give sample code if you can.
31+
- What you expected would happen
32+
- What actually happens
33+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

0 commit comments

Comments
 (0)