From 9d70e02aba638a1180f41505936b72ba84ab17e9 Mon Sep 17 00:00:00 2001 From: inkarkat Date: Mon, 13 Sep 2010 01:26:23 -0700 Subject: [PATCH] Migrated from developer-documentation v5 --- Developer-Documentation.textile | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/Developer-Documentation.textile b/Developer-Documentation.textile index 9715a3e..d50850e 100644 --- a/Developer-Documentation.textile +++ b/Developer-Documentation.textile @@ -3,3 +3,36 @@ To contribute to Todo.txt CLI, fork "the repository":http://github.com/ginatrapa * [[Creating Add-ons: Examples]] * [[Using the Makefile]] * "Known Bugs":http://github.com/ginatrapani/todo.txt-cli/issues + +h2. Contributing patches and enhancements via Git / GitHub + +h3. Initial Fork + +You need to register on GitHub first - it's free and quick to do. After registering, you need to add your SSH public keys to be able to push your changes to your repository. On the "Todo.txt GitHub pages":http://github.com/ginatrapani/todo.txt-cli/tree/master, click the __Fork this project__ button. This will create your personal fork git@github.com:username/projectname.git. + +On your dev system, install Git and clone your repository: + +
+git clone git@github.com:username/todo.txt-cli.git
+git remote add upstream git://github.com/maintainer/todo.txt-cli.git
+git fetch upstream
+
+ +h3. Publishing Changes + +
+git add ...
+git commit ...
+git push origin master
+
+ +The changes now appear in your repository in your GitHub clone; you'll see the commits listed in the GitHub web interface. You can now initiate a pull request by clicking the __Pull Request__ button. + +h3. Pulling in Upstream + +Some time has passed, the upstream repo has changed and you want to update your fork before you submit a new patch. Do this to bring your dev system up-to-date: + +
+git fetch upstream
+git merge upstream/master
+