From 4c2814417198c0cdc012aeaae702a73192bcd86b Mon Sep 17 00:00:00 2001 From: Anton Gerasimov Date: Mon, 8 Oct 2018 12:19:53 +0200 Subject: Add contributor/reviewer checklist --- CONTRIBUTING.adoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 4ad9836..165e80c 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -11,3 +11,15 @@ Previously, some older branches were also regularly supported, and while they sh * morty If 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. + +== Contributor checklist + +* OTA-enabled build succeeds at least for one platform, the resulted image boots. This check is absolutely necessary for every pull request unless it only touches documentation. +* If your change is touching platform code (like `classes/sota_.bbclass`), please check build and update on this particular platform. +* oe-selftest succeeds. To test meta-updater, run `oe-selftest -r updater` from a build directory with `MACHINE` set to `qemux86-64`. +* 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. + +We understand that making all these tests might be overly tedious taking in account build times in Yocto. Please add a comment to your PR describing the tests you've made. + +== Approval +PR approval should be accompanied by a comment describing what tests have been made by the reviewer. -- cgit v1.2.3-54-g00ecf