Skip to content
Browse files

Update README and add CONTRIBUTING file

Signed-off-by: Eddie Ringle <eddie@eringle.net>
  • Loading branch information...
1 parent 70bdcc8 commit 34b5b7a958934d4cc07c57ac02086dc4aa8a1314 @EddieRingle committed Jan 22, 2011
Showing with 14 additions and 4 deletions.
  1. +8 −0 CONTRIBUTING
  2. +6 −4 README
View
8 CONTRIBUTING
@@ -0,0 +1,8 @@
+Hubroid's GitHub: http://github.com/eddieringle/hubroid
+
+If you'd like to help out with Hubroid, here's a couple guidelines you should follow:
+
+* Follow all Android Coding Style Guidelines, especially:
+ - Spaces, not tabs; Use 4 of them
+ - Member names should follow the form of "mVariable", not "m_variable" or "_variable".
+* Develop on your fork, then send me a pull request when you're ready for a review
View
10 README
@@ -1,6 +1,8 @@
-This application allows you to access various information about GitHub repositories and users through the GitHub API.
-
-Hubroid is available in free and donate versions on the Android Market and on SlideME.
+This application allows you to access various information about GitHub repositories and users
+through the GitHub API.
Please suggest new features and report bugs via GitHub:
-http://code.idlesoft.net/projects/hubroid/issues
+http://github.com/eddieringle/hubroid
+
+If you'd like to contribute code, see the CONTRIBUTING file for some guidelines and the TODO file
+or the Issues list on GitHub to see what needs doing.

0 comments on commit 34b5b7a

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