Skip to content
This repository was archived by the owner on Nov 9, 2017. It is now read-only.
/ proteus Public archive

Commit ce5e627

Browse files
author
Joshua Ogle
committed
Add link to Code of Conduct
1 parent 995562a commit ce5e627

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
We love pull requests from everyone. By participating in this project, you
2+
agree to abide by the thoughtbot [code of conduct]. Here’s a quick guide:
3+
4+
[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
5+
6+
1. Fork the repository.
7+
2. Make your changes in a topic branch.
8+
3. Squash your commits into a single one (more on that
9+
[here](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)).
10+
4. Rebase against `origin/master`, push to your fork and submit a pull request.
11+
12+
At this point you’re waiting on us. We like to at least comment on, if not
13+
accept, pull requests within three business days (and, typically, one business
14+
day). We may suggest some changes or improvements or alternatives.
15+
16+
Some things that will increase the chance that your pull request is accepted:
17+
18+
* Write your code according to the [thoughtbot Style Guide][guide]
19+
* Fix a bug, refactor code or expand an existing feature.
20+
* Use the right syntax and naming conventions.
21+
* Update parts of the documentation that are affected by your contribution.
22+
23+
[guide]: https://github.com/thoughtbot/guides/tree/master/style
24+
25+
**Git Commit Messages**
26+
27+
* Capitalize your commit messages.
28+
* Start your message with a verb.
29+
* Use present tense.
30+
* Refer to the issue/PR number in your squashed commit message.

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,21 @@ We’ve also included some handy shortcuts with Proteus:
4646
proteus deploy
4747
```
4848

49+
## Contributing
50+
51+
If you'd like to contribute a feature or bugfix: Thanks! To make sure your
52+
fix/feature has a high chance of being included, please read the following
53+
guidelines:
54+
55+
1. Fork the repository
56+
2. Make your changes
57+
3. Push your branch to your fork
58+
4. Post a [pull request](https://github.com/thoughtbot/proteus/compare).
59+
60+
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details on contributing and running test.
61+
62+
Thank you to all [the contributors](https://github.com/thoughtbot/proteus-middleman/contributors)!
63+
4964
## Credits
5065

5166
[![thoughtbot](http://images.thoughtbot.com/bourbon/thoughtbot-logo.svg)](http://thoughtbot.com)

0 commit comments

Comments
 (0)