diff --git a/contributing.md b/contributing.md index bab093c6e7f6b..55bb493979e6c 100644 --- a/contributing.md +++ b/contributing.md @@ -1,23 +1,25 @@ # Contributing -#### Git-it Challenge Completions +### Git-it Challenge Completions -If you're working through the challenges in Git-it, you'll know most of this, but for the record: +If you're working through the challenges in [Git-it](http://www.github.com/jlord/git-it), you'll know most of this, but for the record: - Fork this repository. - Create a branch named in this pattern: `add-`, where username, not in brackets, is your GitHub username. -- Create a file inside of `/contributors` named `add-.txt`, where username, not in brackets, is your GitHub username. +- Create a file inside of `/contributors` named `add-.txt`, where username, not in brackets, is your GitHub username. That file should just contain your username. - Push your branch to your fork. +- Add @reporobot as a collaborator to your fork. + - Pull in changes that @reporobot will make to the file (he's gonna awesomize your username!) - Submit a pull request to this repository against your `add-` branch. -#### Bug fixes to Patchwork Site +### Bug fixes to Patchwork Site If you're contributing a patch to the Patchwork HTML page itself, make sure the branch name for the branch you create for your changes **does not** include your GitHub username. As a part of the Git-it workshop that uses this repository, users complete the challenge on pull requests with a branch that includes their username. In order to keep bug fixes separate from workshop completions -- don't use your username in your branch :) diff --git a/readme.md b/readme.md index 9f43c78627515..1176c7c1a4d27 100644 --- a/readme.md +++ b/readme.md @@ -1 +1,7 @@ -Work in progress. \ No newline at end of file +# Patchwork + +This repository is a website hosted by [GitHub Pages](http://pages.github.com). It goes along with [Git-it](http://www.github.com/jlord/git-it), a terminal based workshop for learning Git and GitHub. + +Users fork this repository and learn things like (forking) branching, adding collaborators, pulling in changes, pushing to a remote branch and submitting pull request. Once their pull request comes in, @reporobot rewrites the index.html here to include the user. + +#### So much social coding goodness! :octocat: \ No newline at end of file