diff options
author | Andre Arko <andre@arko.net> | 2013-07-24 23:00:04 -0700 |
---|---|---|
committer | Andre Arko <andre@arko.net> | 2013-07-24 23:00:04 -0700 |
commit | 1a493004fd0646d53633eadcb02de17b206289b9 (patch) | |
tree | 22b0aeb3753744a18f4abc07af58535ade5d978f | |
parent | 85815a73cf960d47660c327108697b1ba99595e7 (diff) | |
download | bundler-1a493004fd0646d53633eadcb02de17b206289b9.tar.gz |
expand contribute, mention alias
-rw-r--r-- | CONTRIBUTE.md | 25 |
1 files changed, 16 insertions, 9 deletions
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index af0bae53cc..f1808dfba0 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,4 +1,4 @@ -Great to have you here! Here are a few ways you can help out with [Bundler](http://github.com/bundler/bundler) +Great to have you here! Here are a few ways you can help out with [Bundler](http://github.com/bundler/bundler). # Learn & listen @@ -6,23 +6,30 @@ You can start learning about Bundler by reading [the documentation](http://gembu ## Core Team -The Bundler core team consists of André Arko ([@indirect](http://github.com/indirect)), Terence Lee ([@hone](http://github.com/hone)), and Jessica Lynn Suttles ([@jlsuttles](http://github.com/jlsuttles)), with support and advice from original Bundler author Yehuda Katz ([@wycats](http://github.com/wycats)) +The Bundler core team consists of André Arko ([@indirect](http://github.com/indirect)), Terence Lee ([@hone](http://github.com/hone)), and Jessica Lynn Suttles ([@jlsuttles](http://github.com/jlsuttles)), with support and advice from original Bundler author Yehuda Katz ([@wycats](http://github.com/wycats)). -# How to Set Up Bundler for Development +# Development setup -Install Bundler development dependencies +Bundler doesn't use a Gemfile to list development dependencies, because when we tried it we couldn't tell if we were awake or it was just another level of dreams. To work on Bundler, you'll probably want to do a couple of things. - `$ rake spec:deps` + 1. Install Bundler's development dependencies + $ rake spec:deps -Run the Bundler test suite + 2. Run the test suite, to make sure things are working - `$ rake spec` + $ rake spec + + 3. Set up a shell alias to run Bundler from your clone. I use a Bash alias: + + $ alias dbundle='ruby -I ~/src/bundler/bundler/lib ~/src/bundler/bundler/bin/bundle' + + With that set up, you can test changes you've made to Bundler by running `dbundle`, without interfering with the regular `bundle` command. # Adding new features -When adding a new feature to Bundler, please follow these steps: +If you would like to add a new feature to Bundler, please follow these steps: 1. [Create an issue](https://github.com/bundler/bundler/issues/new) to discuss your feature. 2. Base your commits on the master branch, since we follow [SemVer](http://semver.org) and don't add new features to old releases. @@ -101,7 +108,7 @@ Examples of how Bundler is used help everyone, and we’ve discovered that peopl If you let someone on the core team know you wrote about Bundler, we will add your post to the list of Bundler resources on the Github project wiki. -# Your first bugfix +# Your first commits If you’re interested in contributing to Bundler, that’s awesome! We’d love your help. |