diff options
| author | Patrick Vacek <patrickvacek@gmail.com> | 2018-10-09 17:28:55 +0200 |
|---|---|---|
| committer | Patrick Vacek <patrickvacek@gmail.com> | 2018-10-09 17:30:28 +0200 |
| commit | 771bb670f85d2757f637ba7e8058b8e31d69d482 (patch) | |
| tree | 5b4d75f1c7300c0442854cfb03cc66fcf4a53bdd | |
| parent | 751e8b6e46acc957b6ec47c30868835be4c89d52 (diff) | |
| download | meta-updater-doc/add-rebase-requirement.tar.gz | |
CONTRIBUTING.adoc: Add rebasing requirement.doc/add-rebase-requirement
| -rw-r--r-- | CONTRIBUTING.adoc | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 165e80c..cd6e981 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc | |||
| @@ -14,12 +14,14 @@ If you are developing with meta-updater, it may be helpful to read the README an | |||
| 14 | 14 | ||
| 15 | == Contributor checklist | 15 | == Contributor checklist |
| 16 | 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. | 17 | * OTA-enabled build succeeds at least for one platform, the resulted image boots, and an update can be installed. 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. | 18 | * If your change touches platform code (like `classes/sota_<platform>.bbclass`), please check building and updating 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`. | 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. | 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 | * 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 | 22 | ||
| 22 | 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. | 23 | We 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 | ||
| 24 | == Approval | 25 | == Approval |
| 25 | PR approval should be accompanied by a comment describing what tests have been made by the reviewer. | 26 | |
| 27 | PR approval should be accompanied by a comment describing what tests have been done by the reviewer. | ||