From f483dbf8549e6ca992aebb362ae727feaaa5b17a Mon Sep 17 00:00:00 2001 From: Sam Heyman Date: Tue, 31 Jul 2018 11:24:52 +0200 Subject: [PATCH 1/2] Improve the contributors guide --- .github/CONTRIBUTING.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index bd53005a..7ac9c3c9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,13 +16,15 @@ We are trying to keep 100% coverage, so keep an eye on the `coverage` folder for ### Using a library locally +#### Method 1 + To use a library locally as a dependency, simply link to this library in your project by path: ```ruby gem 'amadeus', path: '../path/to/clone' ``` -To install quickly get playing with your code we have added a console that automatically includes the gem into the gem path. +To install quickly and get playing with your code we have added a console that automatically includes the gem into the gem path. ```sh rake console @@ -35,6 +37,33 @@ Alternatively you can use Amadeus in your script as follows. ruby -r amadeus -I ./lib script.rb ``` +#### Method 2 + +Add all your files to your git repo: + +```sh +git add --all +``` + +This is required because the files that are packaged in the library (edited) can only be packaged if they are added to the git repo +(not commited). + +Then run the following 3 commands to generate the gem locally and to install it in the amadeus-ruby project: + +```sh +build amadeus.gemspec +``` + +```sh +gem uninstall amadeus +``` + +```sh +gem install amadeus-1.0.0.gem +``` + + + ### Releasing To make a new release, follow the following steps: From 753441ceac5e7c366dd43db87c85a6ae510c777c Mon Sep 17 00:00:00 2001 From: Sam Heyman Date: Tue, 31 Jul 2018 11:27:41 +0200 Subject: [PATCH 2/2] fix small typo --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7ac9c3c9..d4d3e276 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -48,7 +48,7 @@ git add --all This is required because the files that are packaged in the library (edited) can only be packaged if they are added to the git repo (not commited). -Then run the following 3 commands to generate the gem locally and to install it in the amadeus-ruby project: +Then run the following 3 commands to generate the gem locally and install it in the amadeus-ruby project: ```sh build amadeus.gemspec