Contributions via github pull requests are more than welcome.
- git client (used for source version control).
- github account (to contribute changes).
- ssh client (used to authenticate with github).
There are 2 main branches used for maintaining quality of experieece.
-
Primary is the stable branch and also the branch thatis pulled in by users through Maiden.
-
Dev is the "bleeding edge" branch and should only be used by those that are helping debug, contributing, or those that like to live dangerously.
-
ensure all the dependencies described in the previous section are installed.
-
fork
https://github.com/frederickk/orcainto your own github account (more on forking here). -
if you haven't configured your machine with an ssh key that's known to github then follow these directions.
-
Clone your forked repo and navigate to a local directory to hold your sources.
$ git clone https://github.com/<your_name_here>/orca.git orca-dev
$ cd orca-dev- Add remote to primary repository, so that you can
git fetchand merge changes made there to your local fork
$ git remote add upstream https://github.com/frederickk/orca.git
To start working on a patch:
$ git fetch upstream
$ git checkout upstream/master -b name_of_your_branchStart hacking away! And update your repo on Github as you work
$ git commit -a -m "<your brief but informative commit message>"`
$ git push origin name_of_your_branch`- go to
https://github.com/frederickk/orcaand click the "Compare & pull request" button. - be sure and include a description of the proposed change and reference any related issues or folks; note that if the change is significant, consider opening a corresponding github issue to discuss. (for some basic advice on writing a pr, see the github's notes on writing a perfect pr.)
Once I've had a chance to review the code and test it I'll merge and et violà!