From 69409fa2b39d12345c793d41d14b8ae896b6313e Mon Sep 17 00:00:00 2001 From: Joseph Poirier Date: Tue, 14 Feb 2017 13:18:04 -0600 Subject: [PATCH] Add contrib info to the readme (#42) * add contrib info * indention * additional info/formatting * fix spelling --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 7f9ce0dc..8971090a 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,27 @@ rtl-sdr turns your Realtek RTL2832 based DVB dongle into a SDR receiver # For more information see: http://sdr.osmocom.org/trac/wiki/rtl-sdr + + +# Contributing + +Pull requests are always welcome but please make changes to, and pull request from, the development branch. + +Initial setup: + +- fork the main librtlsdr repo via github +- clone your fork locally and cd to the cloned repo's folder +- add the upstream development repo: + * git remote add upstream git@github.com:librtlsdr/librtlsdr.git +- track the development branch: + * git branch --track development origin/development + +Normal workflow: + +- checkout the development branch and make your changes +- commit your changes +- sync your local development branch with the upstream development branch: + * git fetch upstream + * git merge upstream/development +- push your commit/s to your forked repo +- do a pull request via github