Download as
Browse Code »

Commit ccfbbece6da7c592396acac6c812687ce9eaef3c

Authored by Nathan B
1 parent 7f9660a2
Exists in master and in 1 other branch production

Added more info to 'Contributing' section in README. Partly to fix a strange Mar… 

…kdown issue that was turning all of the bullets into headings.
Showing 1 changed file with 18 additions and 5 deletions   Show diff stats
@@ -225,6 +225,7 @@ TODO @@ -225,6 +225,7 @@ TODO
225 225
226 * Add ability for watchers to be configured for types of notifications they should receive 226 * Add ability for watchers to be configured for types of notifications they should receive
227 227
  228 +
228 Special Thanks 229 Special Thanks
229 -------------- 230 --------------
230 231
@@ -233,16 +234,28 @@ Special Thanks @@ -233,16 +234,28 @@ Special Thanks
233 * [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. 234 * [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.
234 * [Thoughtbot](http://thoughtbot.com) - For being great open-source advocates and setting the bar with [Airbrake](http://airbrakeapp.com). 235 * [Thoughtbot](http://thoughtbot.com) - For being great open-source advocates and setting the bar with [Airbrake](http://airbrakeapp.com).
235 236
  237 +
236 Contributing 238 Contributing
237 ------------ 239 ------------
238 240
  241 +We welcome any contributions. If you need to tweak Errbit for your organization's needs,
  242 +there are probably other users who will appreciate your work.
  243 +Please try to determine whether or not your feature should be **global** or **optional**,
  244 +and make **optional** features configurable via `config/config.yml`.
  245 +
  246 +**Examples of optional features:**
  247 +
  248 +* Enable / disable user comments on errors.
  249 +* Adding a `username` field to the User model.
  250 +
  251 +**How to contribute:**
  252 +
239 * Fork the project. 253 * Fork the project.
240 * Make your feature addition or bug fix. 254 * Make your feature addition or bug fix.
241 -* Add tests for it. This is important so I don't break it in a  
242 - future version unintentionally.  
243 -* Commit, do not mess with Rakefile, version, or history.  
244 - (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)  
245 -* Send me a pull request. Bonus points for topic branches. 255 +* Add tests for it. This is important so we don't break it in a future version unintentionally.
  256 +* 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)
  257 +* Send us a pull request. Bonus points for topic branches.
  258 +
246 259
247 Copyright 260 Copyright
248 --------- 261 ---------