Skip to content
This repository has been archived by the owner on Jan 16, 2020. It is now read-only.

Commit

Permalink
Added GLPv3 copyright and some hints on contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
zpeters committed Jul 7, 2013
1 parent 4e34927 commit 5dda765
Show file tree
Hide file tree
Showing 4 changed files with 726 additions and 6 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,22 @@
## GitHub Workflow

Developing patches should follow this workflow:

### Initial Setup

1. Fork on GitHub (click Fork button). This creates your own working copy on github.
2. Clone to computer: `git clone git@github.com:<<Your Github Username>>/speedtest.git`
3. cd into your repo: `cd speedtest`
4. Set up remote upstream: `git remote add -f upstream git://github.com/zpeters/speedtest.git`

### Adding a Feature

1. Create a branch for the new feature: `git checkout -b my_new_feature`
2. Work on your feature, add and commit as usual

Creating a branch is not strictly necessary, but it makes it easy to delete your branch when the feature has been merged into upstream, diff your branch with the version that actually ended in upstream, and to submit pull requests for multiple features (branches).

### Pushing to GitHub

8. Push branch to GitHub: `git push origin my_new_feature`
9. Issue pull request: Click Pull Request button on GitHub
12 changes: 12 additions & 0 deletions COPYING
@@ -0,0 +1,12 @@
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

0 comments on commit 5dda765

Please sign in to comment.