Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fusion94 committed Feb 26, 2013
1 parent 6d0ae10 commit e1cb85f
Showing 1 changed file with 38 additions and 14 deletions.
52 changes: 38 additions & 14 deletions CONTRIBUTING.md
@@ -1,17 +1,8 @@
# How to contribute

Third-party patches are essential for keeping kandan great. We simply can't access the huge number of platforms and
myriad configurations for running kandan. We want to keep it as easy as possible to contribute changes that get things
working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance
of keeping on top of things.

## Get Involved
# Introduction
Since Kandan is a fully open-source app, we would appreciate if you dive in and start adding features, fixing bugs
(what bugs?), and cleaning up the code.

But before you jump right in there there are a few caveats.

If you’re going to contribute code then you’re going to have to sign our [Contributor License Agreement](http://www.clahub.com/agreements/kandanapp/kandan)
If you’re going to contribute code then we need you to sign our [Contributor License Agreement](http://www.clahub.com/agreements/kandanapp/kandan)
(hereafter referred to as CLA) which is modeled after the one that [NodeJS](http://nodejs.org) uses.

A CLA is a legal document in which you state you are entitled to contribute the code/documentation/translation
Expand All @@ -24,8 +15,41 @@ The CLA also ensures that once you have provided a contribution, you cannot try
a later date. People and companies can therefore use that software, confident that they will not be asked to stop
using pieces of the code at a later date.

You will also really want to take heart and read these two blog posts.
# How to contribute

Third-party patches are essential for keeping Kandan great. We simply can't access the huge number of platforms and
myriad configurations for running Kandan. We want to keep it as easy as possible to contribute changes that get things
working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance
of keeping on top of things.

* Make sure you have a [GitHub Account](https://github.com/signup/free)
* Submit a ticket for your issue, assuming one does not already exist.
* Clearly describe the issue including steps to reproduce when it is a bug.
* Make sure you fill in the earliest version that you know has the issue.
* Fork the repository on GitHub

# Making Changes

* Get the latest code from Github
* Fork the Main Kandan repository.
* Clone your fork of the Kandan repository.
* Add a remote for the main Kandan repo
* To make things easier to integrate and to keep your fork up to date then you need to add the main Kandan repo as a remote reference.
* `git remote add upstream https://github.com/kandanapp/kandan.git`
* Then, when you need to pull the latest from the main Kandan repo, you just fetch and merge the MASTER branch:
* `git fetch upstream`
* `git merge upstream/master`
* You can also use `git pull upstream master` if you want it all in one step.
* Make a branch for your changes
* Create a branch from where you want to base your work.
* Generally you'll want to branch from __MASTER__
* Please use the naming convention "master-[issue-num]" for your branch name to help us keep track of what your patch actually fixes
*







* [How to Contribute Code](https://github.com/kandanapp/kandan/wiki/How-to-Contribute-Code)
* [How to Contribute Issues](https://github.com/kandanapp/kandan/wiki/How-to-Contribute-Issues)

0 comments on commit e1cb85f

Please sign in to comment.