-
-
Notifications
You must be signed in to change notification settings - Fork 33
/
CONTRIBUTING.md.template
37 lines (23 loc) · 1.02 KB
/
CONTRIBUTING.md.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Contributing
We love contributions from everyone.
By participating in this project,
you agree to abide by the thoughtbot [code of conduct].
[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
We expect everyone to follow the code of conduct
anywhere in thoughtbot's project codebases,
issue trackers, chatrooms, and mailing lists.
## Contributing Code
$(INSTALL_DEPENDENCIES)
Fork the repo.
Make sure the tests pass:
$(TEST_RUNNER)
Make your change, with new passing tests. Follow the [style guide][style].
[style]: https://github.com/thoughtbot/guides/tree/master/style
Mention how your changes affect the project to other developers and users in the
`NEWS.md` file.
Push to your fork. Write a [good commit message][commit]. Submit a pull request.
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
Others will give constructive feedback.
This is a time for discussion and improvements,
and making the necessary changes will be required before we can
merge the contribution.