diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 39 |
1 files changed, 10 insertions, 29 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8349280d..8dc0548a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,36 +1,17 @@ -# Contributing +# Contributing to Bundler -Bundler welcomes contributions from *everyone*. While contributing, please follow the project [code of conduct](http://bundler.io/conduct.html), so that everyone can be included. - -If you'd like to help make Bundler better, you totally rock! Here are some ways you can contribute: - - - by using prerelease versions (run `gem install bundler --pre`) - - by [reporting bugs you encounter or suggesting new features](https://github.com/bundler/bundler/issues/new) - - by adding to or editing [the Bundler documentation website](http://bundler.io) and [Bundler man pages](http://bundler.io/man/bundle.1.html) - - by [checking issues for completeness](https://github.com/bundler/bundler/blob/master/DEVELOPMENT.md#bug-triage) - - by closing issues that are not complete - - by adding a failing test for reproducible [reported bugs](https://github.com/bundler/bundler/issues) - - by reviewing [pull requests](https://github.com/bundler/bundler/pulls) and suggesting improvements - - by improving existing code, including suggestions from [PullReview](https://www.pullreview.com/github/bundler/bundler/reviews/master) or [CodeClimate](https://codeclimate.com/github/bundler/bundler) - - by [writing code](https://github.com/bundler/bundler/blob/master/DEVELOPMENT.md) (no patch is too small! fix typos or bad whitespace) - - by backfilling [unit tests](https://github.com/bundler/bundler/tree/master/spec/bundler) for modules that lack [coverage](https://codeclimate.com/github/bundler/bundler/coverage) - -If you need help getting started, check out the [DEVELOPMENT.md](https://github.com/bundler/bundler/blob/master/DEVELOPMENT.md) file for steps that will get you up and running. +Welcome to Bundler! We are so happy that you're here. We know it can be daunting to joining a new open source project, so here's a quick overview of what you can expect from this documentation. -Thanks for helping us make Bundler better. - -# Roadmap - -If you're interested in reading some of the potential ideas or plans for Bundler, see the official Bundler [Trello Board](https://trello.com/b/DioUaKgx/bundler). - -# Troubleshooting +Bundler welcomes contributions from *everyone*. While contributing, please follow the project [code of conduct](http://bundler.io/conduct.html), so that everyone can be included. -If you're having a problem, please see [ISSUES](https://github.com/bundler/bundler/blob/master/ISSUES.md) for troubleshooting steps and a guide for how to submit a ticket that will help us solve the problem you are having as quickly as possible. +## Quick start -# Requesting Features +Some guides you might find useful: -Feel free to discuss your ideas or feature requests on any of the lists or channels listed below or [create an issue](https://github.com/bundler/bundler/issues/new) with the `feature-request` label. Feature-wise, we consider Bundler stable, so the core team does not tend to work on feature suggestions. Pull requests are welcome though! +* [Submitting pull requests](doc/development/PULL_REQUESTS.md) +* [Filing an issue](doc/contributing/ISSUES.md) +* [Bug triage](doc/contributing/BUG_TRIAGE.md) -# Discussing Bundler +## Comprehensive guides -If you'd like to discuss features, ask questions, or just engage in general Bundler-focused discussion, please see the [#bundler](irc://irc.freenode.net/#bundler) IRC channel on Freenode, and the [Bundler mailing list](http://groups.google.com/group/ruby-bundler) on Google Groups. +Not finding what you're looking for? More comprehensive guides are [available here](doc/README.md). |