diff options
| author | Paul Barker <pbarker@toganlabs.com> | 2017-05-23 10:26:05 +0100 |
|---|---|---|
| committer | Andrei Gherzan <andrei@gherzan.com> | 2017-05-26 12:16:52 +0100 |
| commit | 03976f7ff12885d1205effe526c83b10ed4252fe (patch) | |
| tree | 461c9904c83f102fb27096b5718b57aedb9311dd /docs/contributing.md | |
| parent | 4f2dd0f0e8d09afcb08c5ec57f20c763814596df (diff) | |
| download | meta-raspberrypi-03976f7ff12885d1205effe526c83b10ed4252fe.tar.gz | |
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 <pbarker@toganlabs.com>
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 36 |
1 files changed, 36 insertions, 0 deletions
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 @@ | |||
| 1 | # Contributing | ||
| 2 | |||
| 3 | ## Mailing list | ||
| 4 | |||
| 5 | The main communication tool we use is a mailing list: | ||
| 6 | * yocto@yoctoproject.org | ||
| 7 | * https://lists.yoctoproject.org/listinfo/yocto | ||
| 8 | |||
| 9 | Feel free to ask any kind of questions but always prepend your email subject | ||
| 10 | with "[meta-raspberrypi]". This is because we use the 'yocto' mailing list and | ||
| 11 | not a perticular 'meta-raspberrypi' mailing list. | ||
| 12 | |||
| 13 | ## Patches and pull requests | ||
| 14 | |||
| 15 | All the contributions should be compliant with the openembedded patch | ||
| 16 | guidelines: http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines | ||
| 17 | |||
| 18 | To contribute to this project you should send pull requests to the github mirror | ||
| 19 | (https://github.com/agherzan/meta-raspberrypi). **Additionally** you can send | ||
| 20 | the patches for review to the above specified mailing list. | ||
| 21 | |||
| 22 | When creating patches for the mailing list, please use something like: | ||
| 23 | `git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin` | ||
| 24 | |||
| 25 | When sending patches to the mailing list, please use something like: | ||
| 26 | `git send-email --to yocto@yoctoproject.org <generated patch>` | ||
| 27 | |||
| 28 | ## Github issues | ||
| 29 | |||
| 30 | In order to manage and trace the meta-raspberrypi issues, we use github issues: | ||
| 31 | https://github.com/agherzan/meta-raspberrypi/issues | ||
| 32 | |||
| 33 | If you push patches which have a github issue associated, please provide the | ||
| 34 | issue number in the commit log just before "Signed-off-by" line(s). Example line | ||
| 35 | for a bug: | ||
| 36 | `[Issue #13]` | ||
