Gyorgy Szing | c805f11 | 2022-11-25 11:53:08 +0100 | [diff] [blame] | 1 | Verification Plan |
| 2 | ================= |
| 3 | |
| 4 | This document describes when and by whom verification steps are to be executed. Since this is an open-source project |
| 5 | maintained by an open community, each contributor is expected to participate. |
| 6 | |
| 7 | Verification during development |
| 8 | ------------------------------- |
| 9 | |
| 10 | When changing existing code, or adding new code, the developer is expected to: |
| 11 | |
| 12 | - run static checks to guard "clean code". |
| 13 | - execute runtime tests on the host machine to ensure features not changed are behaving as before. Verification |
| 14 | efforts targeting regression may be limited based on the expected effects of the change. |
| 15 | - extend unit and component tests to cover changes |
| 16 | |
| 17 | Verification during code review |
| 18 | ------------------------------- |
| 19 | |
| 20 | The code review covers all aspects of a change, including design and implementation. This includes running static checks |
| 21 | and runtime tests. The reviewers are expected to check if tests are extended as needed. |
| 22 | |
| 23 | Verification efforts of a review may be limited to lower costs, based on the expected effects of the change. |
| 24 | |
| 25 | Guarding "main" |
| 26 | --------------- |
| 27 | |
| 28 | All commits of the integration branch shall be verified using the full verification set-up. This verification shall aim |
| 29 | for achieving the highest quality level and shall not make compromises. A change becomes ready to get merged to "main" |
| 30 | after passing the tests. |
| 31 | |
| 32 | |
| 33 | -------------- |
| 34 | |
| 35 | *Copyright (c) 2022, Arm Limited and Contributors. All rights reserved.* |
| 36 | |
| 37 | SPDX-License-Identifier: BSD-3-Clause |