From a0a9a3f7114591a7cc0ed76ace1f9b88576a08c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohnic=CC=81?= Date: Thu, 27 Oct 2011 13:48:42 +0200 Subject: [PATCH] update Readme, History --- HISTORY.md | 5 +++++ README.md | 48 +++++++++++++++++++++++++----------------------- 2 files changed, 30 insertions(+), 23 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 1b080ba7..1ff6f2ee 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,5 +1,10 @@ ## master +* opt in for HTTPS: `git config hub.protocol https` +* add `hub pull-request` +* improve detecting upstream configuration ("tracking" branches) +* introduce `hub --noop` +* `hub apply` now downloads GitHub patches same as `hub am` * `hub create ` to explicitly name a repository * switch API communication to HTTPS * better handling of API HTTP exceptions diff --git a/README.md b/README.md index f4a36f60..22686a8d 100644 --- a/README.md +++ b/README.md @@ -336,34 +336,38 @@ GitHub simpler: Contributing ------------ -Once you've made your great commits: +These instructions assume that you already have `hub` installed and that +you've set it up so it wraps `git` (see "Aliasing"). -1. [Fork][0] hub -2. Create a topic branch - `git checkout -b my_branch` -3. Push to your branch - `git push origin my_branch` -4. Create an [Issue][1] with a link to your branch -5. That's it! +1. Clone hub: + `git clone defunkt/hub` +2. Verify that existing tests pass (see "Development dependencies"): + `rake test` +3. Create a topic branch: + `git checkout -b my_branch` +4. Make your changes – it helps a lot if you write tests first +5. Verify that tests still pass: + `rake test` +6. Fork hub on GitHub (adds a remote named "YOUR_USER"): + `git fork` +7. Push to your fork: + `git push -u YOUR_USER my_branch` +8. Open a pull request describing your changes: + `git pull-request` -### Development Gems -You will need the following gems (and their dependencies) to -contribute to `hub`: +### Development dependencies -* `rake` (`gem install rake`) -* `kicker` (`gem install kicker`) -* `turn` (`gem install turn`) -* `mg` (`gem install mg`) -* `ronn` (`gem install ronn`) -* `webmock` (`gem install webmock`) +You will need the following libraries for development: + +* [ronn](https://github.com/rtomayko/ronn) +* [webmock](https://github.com/bblimke/webmock) Meta ---- -* Code: `git clone git://github.com/defunkt/hub.git` -* Home: -* Bugs: -* List: -* Test: -* Gems: +* Home: +* Bugs: +* Gem: Authors @@ -371,8 +375,6 @@ Authors -[0]: http://help.github.com/forking/ -[1]: http://github.com/defunkt/hub/issues [speed]: http://gist.github.com/284823 [2]: http://github.com/guides/local-github-config [gc]: https://twitter.com/brynary/status/49560668994674688