contributing

welcome

we gladly accept contributions via github pull requests.

things you will need

a git client (used for source version control).
a github account (to contribute changes).
an ssh client (used to authenticate with github).

getting the code and configuring your environment

ensure all the dependencies described in the previous section are installed.
fork https://github.com/monome/norns into 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.
navigate to a local directory to hold your sources.
git clone https://github.com/<your_name_here>/norns.git
cd norns
git remote add upstream https://github.com/monome/norns.git (so that you fetch from the main repository, not your clone, when running git fetch et al.)

contributing code

to start working on a patch:

git fetch upstream
git checkout upstream/main -b name_of_your_branch
hack away
git commit -a -m "<your brief but informative commit message>"
git push origin name_of_your_branch

to send us a pull request (pr):

go to https://github.com/monome/norns and 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 everyone is happy, a maintainer will merge your pr for you.

api docs for main

to view the api docs for the main branch, visit https://monome.org/docs/norns/api.

those docs should be updated after a successful travis build of the norns main branch.

build infrastructure

continuous integration of norns is on

travis (details)