summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPatrick Vacek <patrickvacek@gmail.com>2019-09-04 17:22:33 +0200
committerPatrick Vacek <patrickvacek@gmail.com>2019-09-16 17:38:04 +0200
commit73b95488af0fae3c3b9fb85285b2abef9dea9be0 (patch)
tree687884c8494d78357cfdefcaa86f5d6aa6537097
parenteece3ab3b0deb2cfd8406da7843828473e7d1c35 (diff)
downloadmeta-updater-73b95488af0fae3c3b9fb85285b2abef9dea9be0.tar.gz
Add contributing doc from master.
Signed-off-by: Patrick Vacek <patrickvacek@gmail.com>
-rw-r--r--CONTRIBUTING.adoc24
1 files changed, 23 insertions, 1 deletions
diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc
index df7a717..2db33c5 100644
--- a/CONTRIBUTING.adoc
+++ b/CONTRIBUTING.adoc
@@ -1,4 +1,26 @@
1= Contributing 1= Contributing
2:aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/
2 3
3We welcome pull requests from everyone. It may be helpful to read the README and other documentation for link:README.adoc[this repo], https://github.com/advancedtelematic/aktualizr[aktualizr], and the https://github.com/advancedtelematic/updater-repo/[updater-repo], particularly the sections and development and debugging. 4We welcome pull requests from anyone. The master branch is the primary branch for development, and if you wish to add new functionality, it probably belongs there. We attempt to maintain recent release branches and welcome bug fixes and backports for those. Please see the xref:{aktualizr-docsroot}yocto-release-branches.adoc[release branches] documentation for the current list of supported branches.
4 5
6If you are developing with meta-updater, it may be helpful to read the README and other documentation for link:README.adoc[this repo], https://github.com/advancedtelematic/aktualizr[aktualizr], and the https://github.com/advancedtelematic/updater-repo/[updater-repo], particularly the sections about development and debugging.
7
8== Developer Certificate of Origin (DCO)
9
10All commits in pull requests must contain a `Signed-off-by:` line to indicate that the developer has agreed to the terms of the https://developercertificate.org[Developer Certificate of Origin]. A simple way to achieve that is to use the `-s` flag of `git commit`.
11
12New pull requests will automatically be checked by the https://probot.github.io/apps/dco/[probot/dco].
13
14== Contributor checklist
15
16* OTA-enabled build succeeds for at least one platform, the resulting image boots, and an update can be installed. This check is absolutely necessary for every pull request unless it only touches documentation.
17* If your change touches platform code (like `classes/sota_<platform>.bbclass`), please check building and updating on this particular platform.
18* oe-selftest succeeds. To test meta-updater, run `oe-selftest -r updater` from a build directory with `MACHINE` set to `qemux86-64`. See the link:README.adoc#qa-with-oe-selftest[relevant section of the README] for more details.
19* Updates are forwards- and backwards-compatible. You should be able to update an OTA-enabled build before the change is applied to the version with change applied and vice versa. One should pay double attention to the compatibility when bootloader code is affected.
20* The patch/branch should be based on the latest version of the target branch. This may mean that rebasing is necessary if other PRs are merged before yours is approved.
21
22We understand that completing all these tasks might be overly tedious due to build times in Yocto. Please add a comment to your PR describing the tests you've done.
23
24== Approval
25
26PR approval should be accompanied by a comment describing what tests have been done by the reviewer.