Skip to content
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
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Copy link
Contributor

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


```sh
git add --all
Copy link
Contributor

Choose a reason for hiding this comment

The 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:
Expand Down