diff options
Diffstat (limited to 'CONTRIBUTING.adoc')
| -rw-r--r-- | CONTRIBUTING.adoc | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 6e1f219..ffe0d73 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc | |||
| @@ -1,8 +1,9 @@ | |||
| 1 | = Contributing | 1 | = Contributing |
| 2 | :aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/ | ||
| 2 | 3 | ||
| 3 | We 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 link:docs/modules/ROOT/pages/yocto-release-branches.adoc[release branches] documentation for the current list of support branches. | 4 | We 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 support branches. |
| 4 | 5 | ||
| 5 | 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. | 6 | If you are developing with meta-updater, it may be helpful to read the README and other documentation for xref:README.adoc[this repo], https://github.com/advancedtelematic/aktualizr[aktualizr], and the link:https://github.com/advancedtelematic/updater-repo/[updater-repo], particularly the sections about development and debugging. |
| 6 | 7 | ||
| 7 | == Developer Certificate of Origin (DCO) | 8 | == Developer Certificate of Origin (DCO) |
| 8 | 9 | ||
| @@ -14,7 +15,7 @@ New pull requests will automatically be checked by the https://probot.github.io/ | |||
| 14 | 15 | ||
| 15 | * 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. | 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. |
| 16 | * If your change touches platform code (like `classes/sota_<platform>.bbclass`), please check building and updating on this particular platform. | 17 | * If your change touches platform code (like `classes/sota_<platform>.bbclass`), please check building and updating on this particular platform. |
| 17 | * 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. | 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:{aktualizr-docsroot}meta-updater-testing.adoc#qa-with-oe-selftest[relevant section of the README] for more details. |
| 18 | * 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. | 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. |
| 19 | * 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. | 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. |
| 20 | 21 | ||