new contribution guidelines

Stephen Crosby
1 parent 3e4d36a8
Showing 3 changed files with 50 additions and 137 deletions Show diff stats
CONTRIBUTING.md
CONTRIBUTORS.md
README.md
@@ -0,0 +1,45 @@
+# Contributing to Errbit
+
+Thanks for your interest in improving Errbit. We'd love to have you as a
+contributor. Guidelines for contributing code to Errbit depend on the
+nature of your contribution. If your contribution adds a new feature to
+Errbit, the section on 'Feature Requests' does apply. Otherwise, just
+follow the guidelines under 'All Contributions' below.
+
+## All Contributions
+
+All code change contributions should be made through the following steps:
+
+1. Fork errbit/errbit on GitHub
+2. Create a branch with a descriptive name
+3. Make your changes
+4. If your change is non-trivial, add it to the CHANGELOG.md file
+5. Submit a pull request with a clear explanation of what you have
+   changed and why
+
+For code changes:
+- Update the tests to prevent regressions and prove your changes work
+- Update the documentation in the `docs/` folder
+- For anything that should be configurable, use environment variables and
+  update the [configuration documentation](docs/configuration.md)
+
+## Feature Requests
+
+If you'd like to add a feature to Errbit, please start by opening an
+issue on GitHub with a description of what you'd like to add and why. If
+your feature requires a deeper level of discussion, join the #errbit IRC
+channel on freenode to talk it over with the other maintainers.
+
+In general, new features should add value without detracting
+significantly from usability, security, performance, ease of deployment
+and maintainability. Keep in mind that by putting in a pull request for
+a new feature, you are asking other people to maintain your code
+indefinitely. Your feature is more likely to become part of Errbit if it
+appears easy to maintain and if you are able to help maintain it.
+
+Errbit maintainers do review all contributions, but certain kinds of
+contributions take priority. Security-related changes, bug fixes, test
+improvements, documentation improvements, and usability enhancements all
+take priority over feature requests. But we are open to adding new
+features, so if you have a good one in mind, just open a GitHub issue so
+we can start a conversation.
@@ -1,114 +0,0 @@
-## 0.3.0 - Not released yet
-
-- [@arthurnn][]
-- [@emgiezet][]
-- [@jamescmartinez][]
-- [@mildavw][]
-- [@nashby][]
-- [@numbata][]
-- [@shingara][]
-- [@simi][]
-- [@ugisozols][]
-- [@1st8][]
-- [@jozefvaclavik][]
-- [@zhekanax][]
-- [@pkallberg][]
-- [@durrantm][]
-- [@felixbuenemann][]
-- [@soberstadt][]
-- [@rsutphin][]
-
-[@arthurnn]: https://github.com/arthurnn
-[@emgiezet]: https://github.com/emgiezet
-[@jamescmartinez]: https://github.com/jamescmartinez
-[@mildavw]: https://github.com/mildavw
-[@nashby]: https://github.com/nashby
-[@numbata]: https://github.com/numbata
-[@shingara]: https://github.com/shingara
-[@simi]: https://github.com/simi
-[@ugisozols]: https://github.com/ugisozols
-[@1st8]: https://github.com/1st8
-[@jozefvaclavik]: https://github.com/jozefvaclavik
-[@zhekanax]: https://github.com/zhekanax
-[@pkallberg]: https://github.com/pkallberg
-[@durrantm]: https://github.com/durrantm
-[@felixbuenemann]: https://github.com/felixbuenemann
-
-
-
-## 0.2.1 - Not released yet
-
-- [@anicet][]
-- [@nashby][]
-- [@shingara][]
-- [@tscolari][]
-- [@callumd][]
-
-
-[@anicet]: https://github.com/anicet
-[@nashby]: https://github.com/nashby
-[@shingara]: https://github.com/shingara
-[@tscolari]: https://github.com/tscolari
-[@callumd]: https://github.com/callumd
-
-## 0.2.0 - 2013-09-11
-
-- [@2called-chaos][]
-- [@Gonzih][]
-- [@aliscott][]
-- [@arthurnn][]
-- [@bacongobbler][]
-- [@boblail][]
-- [@brendonrapp][]
-- [@jeroenj][]
-- [@mildavw][]
-- [@nfedyashev][]
-- [@parallel588][]
-- [@roryf][]
-- [@shingara][]
-- [@williamn][]
-- [@xenji][]
-
-## 0.1.0 - 2013-05-29
-
-- [@manuelmeurer][]
-- [@mildavw][]
-- [@chadcf][]
-- [@shingara][]
-- [@tvdeyen][]
-- [@adamjt][]
-- [@alvarobp][]
-- [@SamSaffron][]
-- [@sdepold][]
-- [@tamaloa][]
-- [@ivanyv][]
-
-<!-- Contributor on Errbit Thanks to all of them -->
-
-[@2called-chaos]: https://github.com/2called-chaos
-[@Gonzih]: https://github.com/Gonzih
-[@SamSaffron]: https://github.com/SamSaffron
-[@adamjt]: https://github.com/adamjt
-[@aliscott]: http://github.com/aliscott
-[@alvarobp]: https://github.com/alvarobp
-[@arthurnn]: https://github.com/arthurnn
-[@bacongobbler]: https://github.com/bacongobbler
-[@boblail]: https://github.com/boblail
-[@brendonrapp]: https://github.com/brendonrapp
-[@chadcf]: https://github.com/chadcf
-[@ivanyv]: https://github.com/ivanyv
-[@jeroenj]: https://github.com/jeroenj
-[@manuelmeurer]: https://github.com/manuelmeurer
-[@mildavw]: https://github.com/mildavw
-[@mildavw]: https://github.com/mildavw
-[@nfedyashev]: https://github.com/nfedyashev
-[@parallel588]: https://github.com/parallel588
-[@roryf]: https://github.com/roryf
-[@sdepold]: https://github.com/sdepold
-[@shingara]: https://github.com/shingara
-[@tamaloa]: https://github.com/tamaloa
-[@tvdeyen]: https://github.com/tvdeyen
-[@williamn]: https://github.com/williamn
-[@xenji]: https://github.com/xenji
-[@soberstadt]: https://github.com/soberstadt
-[@rsutphin]: https://github.com/rsutphin
@@ -484,38 +484,20 @@ 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://airbrake.io).
-See the [contributors graph](https://github.com/errbit/errbit/graphs/contributors) for further details. You can see another list of Contributors by release version on [CONTRIBUTORS.md]
+See the [contributors graph](https://github.com/errbit/errbit/graphs/contributors) for further details.
 Contributing to Errbit
 ------------
-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 environment variables.
+See the [contribution guidelines](CONTRIBUTING.md)
-**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 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.
-* Add you on the CONTRIBUTORS.md file on the current release
-
-# Running tests
-
-More information can be found in the  [**Errbit Advanced Developer Guide**](docs/DEVELOPER-ADVANCED.md)
+Running tests
+-------------
+Check the .travis.yml file to see how tests are run
 Copyright
 ---------
 Copyright (c) 2010-2014 Errbit Team. See LICENSE for details.
-
@@ -0,0 +1,45 @@		@@ -0,0 +1,45 @@
	1	+# Contributing to Errbit
	2	+
	3	+Thanks for your interest in improving Errbit. We'd love to have you as a
	4	+contributor. Guidelines for contributing code to Errbit depend on the
	5	+nature of your contribution. If your contribution adds a new feature to
	6	+Errbit, the section on 'Feature Requests' does apply. Otherwise, just
	7	+follow the guidelines under 'All Contributions' below.
	8	+
	9	+## All Contributions
	10	+
	11	+All code change contributions should be made through the following steps:
	12	+
	13	+1. Fork errbit/errbit on GitHub
	14	+2. Create a branch with a descriptive name
	15	+3. Make your changes
	16	+4. If your change is non-trivial, add it to the CHANGELOG.md file
	17	+5. Submit a pull request with a clear explanation of what you have
	18	+ changed and why
	19	+
	20	+For code changes:
	21	+- Update the tests to prevent regressions and prove your changes work
	22	+- Update the documentation in the `docs/` folder
	23	+- For anything that should be configurable, use environment variables and
	24	+ update the [configuration documentation](docs/configuration.md)
	25	+
	26	+## Feature Requests
	27	+
	28	+If you'd like to add a feature to Errbit, please start by opening an
	29	+issue on GitHub with a description of what you'd like to add and why. If
	30	+your feature requires a deeper level of discussion, join the #errbit IRC
	31	+channel on freenode to talk it over with the other maintainers.
	32	+
	33	+In general, new features should add value without detracting
	34	+significantly from usability, security, performance, ease of deployment
	35	+and maintainability. Keep in mind that by putting in a pull request for
	36	+a new feature, you are asking other people to maintain your code
	37	+indefinitely. Your feature is more likely to become part of Errbit if it
	38	+appears easy to maintain and if you are able to help maintain it.
	39	+
	40	+Errbit maintainers do review all contributions, but certain kinds of
	41	+contributions take priority. Security-related changes, bug fixes, test
	42	+improvements, documentation improvements, and usability enhancements all
	43	+take priority over feature requests. But we are open to adding new
	44	+features, so if you have a good one in mind, just open a GitHub issue so
	45	+we can start a conversation.
	@@ -1,114 +0,0 @@	@@ -1,114 +0,0 @@
1	-## 0.3.0 - Not released yet
2	-
3	-- [@arthurnn][]
4	-- [@emgiezet][]
5	-- [@jamescmartinez][]
6	-- [@mildavw][]
7	-- [@nashby][]
8	-- [@numbata][]
9	-- [@shingara][]
10	-- [@simi][]
11	-- [@ugisozols][]
12	-- [@1st8][]
13	-- [@jozefvaclavik][]
14	-- [@zhekanax][]
15	-- [@pkallberg][]
16	-- [@durrantm][]
17	-- [@felixbuenemann][]
18	-- [@soberstadt][]
19	-- [@rsutphin][]
20	-
21	-[@arthurnn]: https://github.com/arthurnn
22	-[@emgiezet]: https://github.com/emgiezet
23	-[@jamescmartinez]: https://github.com/jamescmartinez
24	-[@mildavw]: https://github.com/mildavw
25	-[@nashby]: https://github.com/nashby
26	-[@numbata]: https://github.com/numbata
27	-[@shingara]: https://github.com/shingara
28	-[@simi]: https://github.com/simi
29	-[@ugisozols]: https://github.com/ugisozols
30	-[@1st8]: https://github.com/1st8
31	-[@jozefvaclavik]: https://github.com/jozefvaclavik
32	-[@zhekanax]: https://github.com/zhekanax
33	-[@pkallberg]: https://github.com/pkallberg
34	-[@durrantm]: https://github.com/durrantm
35	-[@felixbuenemann]: https://github.com/felixbuenemann
36	-
37	-
38	-
39	-## 0.2.1 - Not released yet
40	-
41	-- [@anicet][]
42	-- [@nashby][]
43	-- [@shingara][]
44	-- [@tscolari][]
45	-- [@callumd][]
46	-
47	-
48	-[@anicet]: https://github.com/anicet
49	-[@nashby]: https://github.com/nashby
50	-[@shingara]: https://github.com/shingara
51	-[@tscolari]: https://github.com/tscolari
52	-[@callumd]: https://github.com/callumd
53	-
54	-## 0.2.0 - 2013-09-11
55	-
56	-- [@2called-chaos][]
57	-- [@Gonzih][]
58	-- [@aliscott][]
59	-- [@arthurnn][]
60	-- [@bacongobbler][]
61	-- [@boblail][]
62	-- [@brendonrapp][]
63	-- [@jeroenj][]
64	-- [@mildavw][]
65	-- [@nfedyashev][]
66	-- [@parallel588][]
67	-- [@roryf][]
68	-- [@shingara][]
69	-- [@williamn][]
70	-- [@xenji][]
71	-
72	-## 0.1.0 - 2013-05-29
73	-
74	-- [@manuelmeurer][]
75	-- [@mildavw][]
76	-- [@chadcf][]
77	-- [@shingara][]
78	-- [@tvdeyen][]
79	-- [@adamjt][]
80	-- [@alvarobp][]
81	-- [@SamSaffron][]
82	-- [@sdepold][]
83	-- [@tamaloa][]
84	-- [@ivanyv][]
85	-
86	-<!-- Contributor on Errbit Thanks to all of them -->
87	-
88	-[@2called-chaos]: https://github.com/2called-chaos
89	-[@Gonzih]: https://github.com/Gonzih
90	-[@SamSaffron]: https://github.com/SamSaffron
91	-[@adamjt]: https://github.com/adamjt
92	-[@aliscott]: http://github.com/aliscott
93	-[@alvarobp]: https://github.com/alvarobp
94	-[@arthurnn]: https://github.com/arthurnn
95	-[@bacongobbler]: https://github.com/bacongobbler
96	-[@boblail]: https://github.com/boblail
97	-[@brendonrapp]: https://github.com/brendonrapp
98	-[@chadcf]: https://github.com/chadcf
99	-[@ivanyv]: https://github.com/ivanyv
100	-[@jeroenj]: https://github.com/jeroenj
101	-[@manuelmeurer]: https://github.com/manuelmeurer
102	-[@mildavw]: https://github.com/mildavw
103	-[@mildavw]: https://github.com/mildavw
104	-[@nfedyashev]: https://github.com/nfedyashev
105	-[@parallel588]: https://github.com/parallel588
106	-[@roryf]: https://github.com/roryf
107	-[@sdepold]: https://github.com/sdepold
108	-[@shingara]: https://github.com/shingara
109	-[@tamaloa]: https://github.com/tamaloa
110	-[@tvdeyen]: https://github.com/tvdeyen
111	-[@williamn]: https://github.com/williamn
112	-[@xenji]: https://github.com/xenji
113	-[@soberstadt]: https://github.com/soberstadt
114	-[@rsutphin]: https://github.com/rsutphin
	@@ -484,38 +484,20 @@ Special Thanks		@@ -484,38 +484,20 @@ Special Thanks
484	* [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.	484	* [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.
485	* [Thoughtbot](http://thoughtbot.com) - For being great open-source advocates and setting the bar with [Airbrake](http://airbrake.io).	485	* [Thoughtbot](http://thoughtbot.com) - For being great open-source advocates and setting the bar with [Airbrake](http://airbrake.io).
486		486
487	-See the [contributors graph](https://github.com/errbit/errbit/graphs/contributors) for further details. You can see another list of Contributors by release version on [CONTRIBUTORS.md]	487	+See the [contributors graph](https://github.com/errbit/errbit/graphs/contributors) for further details.
488		488
489		489
490	Contributing to Errbit	490	Contributing to Errbit
491	------------	491	------------
492		492
493	-We welcome any contributions. If you need to tweak Errbit for your organization's needs,
494	-there are probably other users who will appreciate your work.
495	-Please try to determine whether or not your feature should be global or optional,
496	-and make optional features configurable via environment variables.	493	+See the [contribution guidelines](CONTRIBUTING.md)
497		494
498	-Examples of optional features:
499	-
500	-* Enable / disable user comments on errors.
501	-* Adding a `username` field to the User model.
502	-
503	-How to contribute:
504	-
505	-* Fork the project.
506	-* Make your feature addition or bug fix.
507	-* Add tests for it. This is important so we don't break it in a future version unintentionally.
508	-* 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)
509	-* Send us a pull request. Bonus points for topic branches.
510	-* Add you on the CONTRIBUTORS.md file on the current release
511	-
512	-# Running tests
513	-
514	-More information can be found in the [Errbit Advanced Developer Guide](docs/DEVELOPER-ADVANCED.md)	495	+Running tests
		496	+-------------
515		497
		498	+Check the .travis.yml file to see how tests are run
516		499
517	Copyright	500	Copyright
518	---------	501	---------
519		502
520	Copyright (c) 2010-2014 Errbit Team. See LICENSE for details.	503	Copyright (c) 2010-2014 Errbit Team. See LICENSE for details.
521	-