diff options
author | Liz Abinante <eabinante@gmail.com> | 2017-01-23 18:39:43 -0800 |
---|---|---|
committer | Liz Abinante <eabinante@gmail.com> | 2017-01-23 18:41:00 -0800 |
commit | 5aec4a55c259965feedecaefcd6ceeff19b7c9de (patch) | |
tree | 9f430e34542ef7a65eadfa26872cacea852b5df2 | |
parent | 381912e494bb912d9953af5f3cff5ad4f248cc51 (diff) | |
download | bundler-5aec4a55c259965feedecaefcd6ceeff19b7c9de.tar.gz |
:sparkles: quick start contribution guide
-rw-r--r-- | CONTRIBUTING.md | 17 | ||||
-rw-r--r-- | doc/README.md | 2 |
2 files changed, 18 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..8dc0548add --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing to Bundler + +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. + +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. + +## Quick start + +Some guides you might find useful: + +* [Submitting pull requests](doc/development/PULL_REQUESTS.md) +* [Filing an issue](doc/contributing/ISSUES.md) +* [Bug triage](doc/contributing/BUG_TRIAGE.md) + +## Comprehensive guides + +Not finding what you're looking for? More comprehensive guides are [available here](doc/README.md). diff --git a/doc/README.md b/doc/README.md index 25250855c1..534dd941a7 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,6 +1,6 @@ # Docs: Contributing and developing Bundler -_If you're looking for documentation on how to use Bundler, visit [bundler.io](http://bundler.io/), or run `bundle help` from the command line. You may also be interested in [troubleshooting common issues](TROUBLESHOOTING.md) found when using Bundler._ +_If you're looking for documentation on how to use Bundler: visit [bundler.io](http://bundler.io/), or run `bundle help` from the command line. You may also be interested in [troubleshooting common issues](TROUBLESHOOTING.md) found when using 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. |