mirror of
https://github.com/fog/fog.git
synced 2022-11-09 13:51:43 -05:00
[docs] Updates contributing notes
* Mentions changes should support 1.8.7 and 1.9 * Suggests looking at code metrics for possible help * Updates config file for testing (now `tests/.fog`) * Updated on fog.io docs as well I think the docs could be opened up a lot more so this is a first pass at improvements. [#1270]
This commit is contained in:
parent
b24a37824c
commit
da9981c773
2 changed files with 14 additions and 5 deletions
10
README.md
10
README.md
|
@ -113,11 +113,15 @@ geemus says: "That should give you everything you need to get started, but let m
|
|||
|
||||
## Contributing
|
||||
|
||||
* Find something you would like to work on. For suggestions look for the `easy`, `medium` and `hard` tags in the [issues](https://github.com/fog/fog/issues)
|
||||
* Find something you would like to work on.
|
||||
* Look for anything you can help with in the [issue tracker](https://github.com/fog/fog/issues).
|
||||
* Look at the [code quality metrics](https://codeclimate.com/github/fog/fog) for anything you can help clean up.
|
||||
* Or anything else!
|
||||
* Fork the project and do your work in a topic branch.
|
||||
* Add a config at `~/.fog` for the component you want to test.
|
||||
* Make sure your changes will work on both Ruby 1.8.7 and Ruby 1.9
|
||||
* Add a config at `tests/.fog` for the component you want to test.
|
||||
* Add shindo tests to prove your code works and run all the tests using `bundle exec rake`.
|
||||
* Rebase your branch against fog/fog to make sure everything is up to date.
|
||||
* Rebase your branch against `fog/fog` to make sure everything is up to date.
|
||||
* Commit your changes and send a pull request.
|
||||
|
||||
## Additional Resources
|
||||
|
|
|
@ -42,10 +42,15 @@ geemus says: "That should give you everything you need to get started, but let m
|
|||
|
||||
## Contributing
|
||||
|
||||
* Find something you would like to work on. For suggestions look for the `easy`, `medium` and `hard` tags in the [issues](http://github.com/fog/fog/issues)
|
||||
* Find something you would like to work on.
|
||||
* Look for anything you can help with in the [issue tracker](https://github.com/fog/fog/issues).
|
||||
* Look at the [code quality metrics](https://codeclimate.com/github/fog/fog) for anything you can help clean up.
|
||||
* Or anything else!
|
||||
* Fork the project and do your work in a topic branch.
|
||||
* Make sure your changes will work on both Ruby 1.8.7 and Ruby 1.9.
|
||||
* Add a config at `tests/.fog` for the component you want to test.
|
||||
* Add shindo tests to prove your code works and run all the tests using `bundle exec rake`.
|
||||
* Rebase your branch against fog/fog to make sure everything is up to date.
|
||||
* Rebase your branch against `fog/fog` to make sure everything is up to date.
|
||||
* Commit your changes and send a pull request.
|
||||
|
||||
## Resources
|
||||
|
|
Loading…
Reference in a new issue