From 562c85924cf881e9315f76f20f889df54b0a7c83 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 21 Jan 2014 18:28:54 -0800 Subject: [PATCH] add docs --- LICENSE.md | 25 +++++++++++++++++++++++++ contributing.md | 26 +++++++++++++++++++++++++- 2 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000000000..78613ebf97395 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,25 @@ +# BSD Open Source + +Copyright (c) 2014, Jessica Lord +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/contributing.md b/contributing.md index 31131687e0589..bab093c6e7f6b 100644 --- a/contributing.md +++ b/contributing.md @@ -1 +1,25 @@ -- reporobot PR filter \ No newline at end of file +# Contributing + +#### Git-it Challenge Completions + +If you're working through the challenges in 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. + +- Push your branch 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 + +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 :) + + +### Thanks for Contributing! :octocat: :heart: \ No newline at end of file