Updated the contributor workflow in the readme

pull/14/head
Jon 14 years ago committed by Tim Su
parent 0625a34582
commit 0ca9cb6210

@ -16,7 +16,9 @@ Getting Started With Development
*[Eclipse](http://eclipse.org)* (preferred: Eclipse IDE for Java Developers)
• *[Android SDK](http://developer.android.com/sdk/index.html)*
3. Use **git** to clone your forked repository (see Github's instructions if you need help). Follow the [Github Line Ending Help](http://help.github.com/dealing-with-lineendings/)
3. Use **git** to clone your forked repository
`git clone git@github.com:yourgithubid/astrid.git`
(see Github's instructions if you need help). Follow the [Github Line Ending Help](http://help.github.com/dealing-with-lineendings/)
4. Clone the [astridApi](http://github.com/todoroo/astridApi) github project. This is an [Android Library Project](http://developer.android.com/guide/developing/eclipse-adt.html#libraryProject) and so you will need ADT version 0.9.7+. Put the astridApi folder in the same root level folder as the astrid folder.
@ -28,6 +30,29 @@ Getting Started With Development
7. Check out the [Product Roadmap](http://wiki.github.com/todoroo/astrid/) and [Issues](http://github.com/todoroo/astrid/issues), and look for something you'd want to tackle.
8. Follow the following contributors workflow:
Suggested workflow:
`git clone git@github.com:yourgithubid/astridApi.git`
`git remote add astrid git://github.com/todoroo/astrid.git`
`git checkout -b my-new-features`
work, work, work!
`git commit` (a separate commit for each bug fix, feature change, style or copy edit please!)
`git fetch astrid`
`git rebase -i astrid/master` (i like to rebase -i to verify what i'm committing and squish small commits)
`git push origin my-new-features`
then go to github and submit a pull request
Contact
-------
For support requests, use the Astrid issue tracker. For development questions, contact [timsu](http://github.com/timsu) via e-mail.

Loading…
Cancel
Save