summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOYTIS <tossel@gmail.com>2018-10-08 15:22:27 +0200
committerGitHub <noreply@github.com>2018-10-08 15:22:27 +0200
commit751e8b6e46acc957b6ec47c30868835be4c89d52 (patch)
tree2bdc1a2feef3cdc419d22383a9780035ea9252d9
parenta72ee0080f97a90e20de27d4db7086fb3a51e6ab (diff)
parent4c2814417198c0cdc012aeaae702a73192bcd86b (diff)
downloadmeta-updater-751e8b6e46acc957b6ec47c30868835be4c89d52.tar.gz
Merge pull request #401 from advancedtelematic/checklist
Add contributor/reviewer checklist
-rw-r--r--CONTRIBUTING.adoc12
1 files changed, 12 insertions, 0 deletions
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
11* morty 11* morty
12 12
13If 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. 13If 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.
14
15== Contributor checklist
16
17* 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.
18* If your change is touching platform code (like `classes/sota_<platform>.bbclass`), please check build and update on this particular platform.
19* oe-selftest succeeds. To test meta-updater, run `oe-selftest -r updater` from a build directory with `MACHINE` set to `qemux86-64`.
20* 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.
21
22We 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.
23
24== Approval
25PR approval should be accompanied by a comment describing what tests have been made by the reviewer.