diff --git a/README.md b/README.md index fc2d379..4083990 100644 --- a/README.md +++ b/README.md @@ -225,6 +225,7 @@ TODO * Add ability for watchers to be configured for types of notifications they should receive + Special Thanks -------------- @@ -233,16 +234,28 @@ Special Thanks * [Relevance](http://thinkrelevance.com) - For giving me Open-source Fridays to work on Errbit and all my awesome co-workers for giving feedback and inspiration. * [Thoughtbot](http://thoughtbot.com) - For being great open-source advocates and setting the bar with [Airbrake](http://airbrakeapp.com). + Contributing ------------ +We welcome any contributions. If you need to tweak Errbit for your organization's needs, +there are probably other users who will appreciate your work. +Please try to determine whether or not your feature should be **global** or **optional**, +and make **optional** features configurable via `config/config.yml`. + +**Examples of optional features:** + +* Enable / disable user comments on errors. +* Adding a `username` field to the User model. + +**How to contribute:** + * Fork the project. * Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with Rakefile, version, or history. - (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. +* Add tests for it. This is important so we don't break it in a future version unintentionally. +* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself we can ignore when we pull) +* Send us a pull request. Bonus points for topic branches. + Copyright --------- -- libgit2 0.21.2