diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..35fbc23 --- /dev/null +++ b/CONTRIBUTING.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. diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md deleted file mode 100644 index aa71635..0000000 --- a/CONTRIBUTORS.md +++ /dev/null @@ -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][] - - - -[@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 diff --git a/README.md b/README.md index 18777bf..0763bb4 100644 --- a/README.md +++ b/README.md @@ -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. - -- libgit2 0.21.2