Skip to content

Commit dfedcd2

Browse files
committed
Merge pull request #471 from allisonurban/master
Added CONTRIBUTING.md and link in README
2 parents d0493d9 + 11748a2 commit dfedcd2

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Pull Requests
2+
-------------
3+
Here are some reasons why a pull request may not be merged:
4+
5+
1. It hasn’t been reviewed.
6+
2. It doesn’t include specs for new functionality.
7+
3. It doesn’t include documentation for new functionality.
8+
4. It changes behavior without changing the relevant documentation, comments, or specs.
9+
5. It changes behavior of an existing public API, breaking backward compatibility.
10+
6. It breaks the tests on a supported platform.
11+
7. It doesn’t merge cleanly (requiring Git rebasing and conflict resolution).
12+
13+
If you would like to help in this process, you can start by evaluating open pull requests against the criteria above. For example, if a pull request does not include specs for new functionality, you can add a comment like: “If you would like this feature to be added to Thor, please add specs to ensure that it does not break in the future.” This will help move a pull request closer to being merged.
14+
15+
Include this emoji in the top of your ticket to signal to us that you read this file: 🌈

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ Please see the [wiki][] for basic usage and other documentation on using Thor. Y
3434
[wiki]: https://github.com/erikhuda/thor/wiki
3535
[homepage]: http://whatisthor.com/
3636

37+
Contributing
38+
------------
39+
If you would like to help, please read the [CONTRIBUTING][] file for suggestions.
40+
41+
[contributing]: CONTRIBUTING.md
42+
3743
License
3844
-------
3945
Released under the MIT License. See the [LICENSE][] file for further details.

0 commit comments

Comments
 (0)