diff --git a/README.md b/README.md index fc980fddf..8830d9a3c 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,25 @@ npm link typescript [pyenv](https://github.com/yyuu/pyenv) [pyenv-virtualenv](https://github.com/yyuu/pyenv-virtualenv) +### Developing + +#### PivotalTracker Integration + +Tag a commit with the Tracker Story ID and GitHub automatically comments on your +story with the commit message. + +Add the following at the end of your commit message: + +``` +[(Finishes|Fixes|Delivers) #TRACKER_STORY_ID] +``` + +When you push to GitHub, the post-receive hook will then call back to Tracker +and put a comment on the story with a link to the commit on GitHub. When tagged +with "Finishes", the trigger will also click Finish on the story. + +Reference: PivotalTracker blog - [A Guide to GitHub’s Service Hook for Tracker](https://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/) + ### Linux