Skip to content

Commit c4f3397

Browse files
author
Jessica Lord
committed
edit docs
1 parent c58b673 commit c4f3397

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

contributing.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
# Contributing
22

3-
#### Git-it Challenge Completions
3+
### Git-it Challenge Completions
44

5-
If you're working through the challenges in Git-it, you'll know most of this, but for the record:
5+
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:
66

77
- Fork this repository.
88

99
- Create a branch named in this pattern: `add-<username>`, where username, not in brackets, is your GitHub username.
1010

11-
- Create a file inside of `/contributors` named `add-<username>.txt`, where username, not in brackets, is your GitHub username.
11+
- Create a file inside of `/contributors` named `add-<username>.txt`, where username, not in brackets, is your GitHub username. That file should just contain your username.
1212

1313
- Push your branch to your fork.
1414

15+
- Add @reporobot as a collaborator to your fork.
16+
1517
- Pull in changes that @reporobot will make to the file (he's gonna awesomize your username!)
1618

1719
- Submit a pull request to this repository against your `add-<username>` branch.
1820

1921

20-
#### Bug fixes to Patchwork Site
22+
### Bug fixes to Patchwork Site
2123

2224
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 :)
2325

readme.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Work in progress.
1+
# Patchwork
2+
3+
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.
4+
5+
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.
6+
7+
#### So much social coding goodness! :octocat:

0 commit comments

Comments
 (0)