Revision 6c5afd55
Added by Ewoud Kohl van Wijngaarden about 4 years ago
| CONTRIBUTING.md | ||
|---|---|---|
|
package manager such as [bundler](https://bundler.io/) what Ruby packages,
|
||
|
or Gems, are required to build, develop, and test this software.
|
||
|
|
||
|
Please make sure you have [bundler installed](https://bundler.io/#getting-started)
|
||
|
on your system, then use it to install all dependencies needed for this project,
|
||
|
by running
|
||
|
|
||
|
```shell
|
||
|
% bundle install
|
||
|
**Prerequisites**
|
||
|
1. Make sure you have [bundler installed](https://bundler.io/#getting-started)
|
||
|
on your system. If you are using Fedora, you can get `bundler` using
|
||
|
```shell
|
||
|
sudo dnf install rubygem-bundler
|
||
|
```
|
||
|
2. If you are using Fedora, you may need these additional packages
|
||
|
```shell
|
||
|
sudo dnf install -y ruby-devel redhat-rpm-config
|
||
|
```
|
||
|
|
||
|
Now, go to the root directory of this project and use `bundler` to install all
|
||
|
dependencies needed for this project by running
|
||
|
|
||
|
```console
|
||
|
$ bundle install
|
||
|
Fetching gem metadata from https://rubygems.org/........
|
||
|
Fetching gem metadata from https://rubygems.org/..
|
||
|
Using rake (10.1.0)
|
||
| ... | ... | |
|
If you already have those gems installed, make sure they are up-to-date:
|
||
|
|
||
|
```shell
|
||
|
% bundle update
|
||
|
bundle update
|
||
|
```
|
||
|
|
||
|
With all dependencies in place and up-to-date we can now run the tests:
|
||
|
|
||
|
```shell
|
||
|
% rake spec
|
||
|
rake spec
|
||
|
```
|
||
|
|
||
|
This will execute all the [rspec tests](http://rspec-puppet.com/) tests
|
||
| ... | ... | |
|
|
||
|
* [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
|
||
|
|
||
|
|
||
|
Modulesync
|
||
|
==========
|
||
|
|
||
|
Various files, including this one, are
|
||
|
[modulesynced](https://github.com/voxpupuli/modulesync) using
|
||
|
[foreman-installer-modulesync](https://github.com/theforeman/foreman-installer-modulesync)
|
||
|
configuration. Changes should be made over there and then synced to
|
||
|
all [managed
|
||
|
modules](https://github.com/theforeman/foreman-installer-modulesync/blob/master/managed_modules.yml).
|
||
Also available in: Unified diff
Modulesync: use voxpupuli helper gems