Skip to content

Commit

Permalink
Add contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
tysongach committed Mar 19, 2017
1 parent 44e1c1d commit 9abcca2
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,43 @@
# 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

1. Fork the repo.

1. Install dependencies:

```
bundle install
```

1. Make sure the tests pass:

```
bundle exec rake test
```

1. Make your change, with new passing tests. Follow the [style guide][style].

1. Mention how your changes affect the project to other developers and users in
the `CHANGELOG.md` file.

1. Write a [good commit message][commit]. Push to your fork. Submit a pull
request.

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.

[style]: https://github.com/thoughtbot/guides/tree/master/style
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
8 changes: 8 additions & 0 deletions README.md
Expand Up @@ -42,6 +42,14 @@ detailing its usage][article].
<a href="/about">About</a>
```

## Contributing

See the [contributing document].
Thank you, [contributors]!

[contributing document]: CONTRIBUTING.md
[contributors]: https://github.com/thoughtbot/middleman-aria_current/graphs/contributors

## License

middleman-aria_current is copyright © 2017 Tyson Gach and thoughtbot, inc.
Expand Down

0 comments on commit 9abcca2

Please sign in to comment.