Skip to content

Commit

Permalink
Update contribution instructions in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Fryguy committed Dec 15, 2016
1 parent 86153ab commit c4877f2
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,25 @@ reports, and policies.

## Contributing

Contribution directions go here.
First, you will need to set up your repo for development.

1. Clone the repo.
2. Set up the ManageIQ application in the spec/manageiq directory. This can be
done in one of two ways.
- Run `bin/setup`. This command will do a shallow clone of ManageIQ into spec/manageiq,
and also prepare any files for setup.
- Create a symlink from spec/manageiq to a local source checkout of ManageIQ.
This is especially useful if you will be modifying ManageIQ itself at the
same time.
3. `bundle`
4. `bundle exec rake spec:setup`

Now you are ready to begin development. You can run the specs with
`bundle exec rake`.

Please be sure to add specs for any new automate methods you create, and follow
the [ManageIQ development guidelines](https://github.com/ManageIQ/guides/blob/master/coding_style_and_standards.md).
Thanks for your contribution!

## License

Expand Down

0 comments on commit c4877f2

Please sign in to comment.