From 03976f7ff12885d1205effe526c83b10ed4252fe Mon Sep 17 00:00:00 2001 From: Paul Barker Date: Tue, 23 May 2017 10:26:05 +0100 Subject: docs: Initial split of README into docs directory The top-level README document has got pretty unwieldy and so we need to switch to add some more structure to our documentation. The first step is to split out sub-sections of the README document into separate files in a new 'docs' directory. Whilst splitting up the README, we can also take the opportunity to tidy things up and fix a couple of typos. Signed-off-by: Paul Barker --- docs/contributing.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/contributing.md (limited to 'docs/contributing.md') diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..370957d --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,36 @@ +# Contributing + +## Mailing list + +The main communication tool we use is a mailing list: +* yocto@yoctoproject.org +* https://lists.yoctoproject.org/listinfo/yocto + +Feel free to ask any kind of questions but always prepend your email subject +with "[meta-raspberrypi]". This is because we use the 'yocto' mailing list and +not a perticular 'meta-raspberrypi' mailing list. + +## Patches and pull requests + +All the contributions should be compliant with the openembedded patch +guidelines: http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines + +To contribute to this project you should send pull requests to the github mirror +(https://github.com/agherzan/meta-raspberrypi). **Additionally** you can send +the patches for review to the above specified mailing list. + +When creating patches for the mailing list, please use something like: +`git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin` + +When sending patches to the mailing list, please use something like: +`git send-email --to yocto@yoctoproject.org ` + +## Github issues + +In order to manage and trace the meta-raspberrypi issues, we use github issues: +https://github.com/agherzan/meta-raspberrypi/issues + +If you push patches which have a github issue associated, please provide the +issue number in the commit log just before "Signed-off-by" line(s). Example line +for a bug: +`[Issue #13]` -- cgit v1.2.3-54-g00ecf