Skip to content
This repository was archived by the owner on Feb 20, 2019. It is now read-only.

Commit 8e4543c

Browse files
author
Kent C. Dodds
committed
docs(contributing): Add acceptable contributions section
1 parent c68b247 commit 8e4543c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,28 @@ a new issue, indicating that you should check out the guidelines first:
99

1010
![contributing-notice](other/contributing-notice.png)
1111

12+
## Acceptable Contributions
13+
14+
This package's purpose is really kind of useless as a node package. I created it to
15+
demonstrate how to contribute to Open Source projects. However, I still have standards!
16+
I only accept pull requests that:
17+
18+
- fix bugs for existing functions
19+
- enhance the API or implementation of an existing function
20+
- adds a function that is only slightly modified from a StackOverflow answer
21+
- is tested (see the `test` directory; we use [`ava`](http://npm.im/ava))
22+
23+
In the case of adding a new function, that function must:
24+
25+
- NOT add anything to the prototype of built-in objects (one of StackOverflow's favorite things to do)
26+
- be exported in the `src/index.js` file
27+
28+
All code must follow the styles dictated by ESLint. As long as you don't skip the git hooks,
29+
you shouldn't need to worry about missing something.
30+
31+
Also, **please discuss any changes in the issues** before working on a PR to make sure
32+
that I'll accept it before you spend time working on it.
33+
1234
## Set up instructions
1335

1436
1. Fork the repo

0 commit comments

Comments
 (0)