Skip to content
Browse files

Merge pull request #1273 from fog/doc_updates

Documentation updates
  • Loading branch information...
2 parents f4ae7a1 + da9981c commit 397b015257a5922298536debe4ebb1eb025152cf @geemus geemus committed Nov 14, 2012
Showing with 15 additions and 6 deletions.
  1. +7 −3 README.md
  2. +8 −3 docs/index.markdown
View
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
View
11 docs/index.markdown
@@ -42,18 +42,23 @@ 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
Enjoy, and let me know what I can do to continue improving fog!
* Work through the [fog tutorial](https://github.com/downloads/geemus/learn_fog/learn_fog.tar.gz)
-* Read fog's [API documentation](/rdoc)
+* Read fog's [API documentation](/doc)
* Stay up to date by following [@fog](http://twitter.com/fog) and/or [@geemus](http://twitter.com/geemus) on Twitter.
* Get and give help on the [#ruby-fog](irc://irc.freenode.net/ruby-fog) irc channel on Freenode
* Follow release notes and discussions on the [mailing list](http://groups.google.com/group/ruby-fog)

0 comments on commit 397b015

Please sign in to comment.
Something went wrong with that request. Please try again.