Skip to content

Commit 562c859

Browse files
author
Jessica Lord
committed
add docs
1 parent e8b1529 commit 562c859

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

LICENSE.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# BSD Open Source
2+
3+
Copyright (c) 2014, Jessica Lord
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
9+
* Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
* Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
16+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
20+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

contributing.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
- reporobot PR filter
1+
# Contributing
2+
3+
#### Git-it Challenge Completions
4+
5+
If you're working through the challenges in Git-it, you'll know most of this, but for the record:
6+
7+
- Fork this repository.
8+
9+
- Create a branch named in this pattern: `add-<username>`, where username, not in brackets, is your GitHub username.
10+
11+
- Create a file inside of `/contributors` named `add-<username>.txt`, where username, not in brackets, is your GitHub username.
12+
13+
- Push your branch to your fork.
14+
15+
- Pull in changes that @reporobot will make to the file (he's gonna awesomize your username!)
16+
17+
- Submit a pull request to this repository against your `add-<username>` branch.
18+
19+
20+
#### Bug fixes to Patchwork Site
21+
22+
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 :)
23+
24+
25+
### Thanks for Contributing! :octocat: :heart:

0 commit comments

Comments
 (0)