-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve contributing file #23
Open
samheyman
wants to merge
3
commits into
amadeus4dev-examples:master
Choose a base branch
from
samheyman:improve-contributing-file
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should only be the files impacted by the update of the library |
||
``` | ||
|
||
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 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: | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have to explain why it's needed, I will work on it later