From cab2515cd0c4a2a6b4170dbd6d680c51037d0c54 Mon Sep 17 00:00:00 2001 From: Martin Pokorny <89339813+mPokornyETM@users.noreply.github.com> Date: Tue, 17 Jan 2023 18:37:39 +0100 Subject: [PATCH 1/3] Update pull-request-template.md --- .../pull-request-template.md | 78 ++++++++++++++++++- 1 file changed, 74 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md index 3f24c0f..37420ea 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md @@ -10,11 +10,81 @@ assignees: '' # Request for a change on public repository on [CtrlppCheck](https://github.com/siemens/CtrlppCheck) ## Basic information + + + + +See #XXXXX + + + -What has been changed and why? Reference an issue from public issue list ## Technical information -- WinCC OA guidelines for C++ and Control(++) coding have been met. -- Result of pipeline build proving error/warning free code. -- Result of automatic tests proving regression free. + +### Testing done + + + +### Proposed upgrade guidelines + +N/A + +### Localizations + + + +- [ ] English +- [ ] German + +### Submitter checklist + +- [ ] The Github issue, if it exists, is well-described. +- [ ] The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood. + - The changelog generator for plugins uses the **pull request title as the changelog entry**. + - Fill in the **Proposed upgrade guidelines** section only if there are breaking changes or changes that may require extra steps from users during the upgrade. +- [ ] There is automated testing or an explanation that explains why this change has no tests. +- [ ] For dependency updates, there are links to external changelogs and, if possible, full differentials. +- [ ] Any localizations are transferred to /msg/ files. + + +### Maintainer checklist + +Before the changes are marked as `ready-for-merge`: + + +- [ ] Changelog entries in the **pull request title** and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood. + +- [ ] If the change needs additional upgrade steps from users, the `upgrade-guide-needed` label is set and there is a **Proposed upgrade guidelines** section in the pull request title (see [example](...)). +- [ ] cpp and ctrl code changes are tested by automated test. +- [ ] WinCC OA guidelines for C++ and Control(++) coding have been met. +- [ ] Result of pipeline build proving error/warning free code. +- [ ] Result of automatic tests proving regression free. From fc239c745a51c68146217cda6daf8c6486b5f408 Mon Sep 17 00:00:00 2001 From: Martin Pokorny <89339813+mPokornyETM@users.noreply.github.com> Date: Wed, 18 Jan 2023 07:34:27 +0100 Subject: [PATCH 2/3] Update .github/PULL_REQUEST_TEMPLATE/pull-request-template.md Co-authored-by: dhoegerlETM <110166248+dhoegerlETM@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE/pull-request-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md index 37420ea..81047c2 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md @@ -84,7 +84,7 @@ Before the changes are marked as `ready-for-merge`: - [ ] Proper changelog labels are set so that the changelog can be generated automatically. See also [release-drafter-labels](...). --> - [ ] If the change needs additional upgrade steps from users, the `upgrade-guide-needed` label is set and there is a **Proposed upgrade guidelines** section in the pull request title (see [example](...)). -- [ ] cpp and ctrl code changes are tested by automated test. +- [ ] C++ and Control(++) code changes are tested by automated test. - [ ] WinCC OA guidelines for C++ and Control(++) coding have been met. - [ ] Result of pipeline build proving error/warning free code. - [ ] Result of automatic tests proving regression free. From 0dddf1f72cdb280704b2a24f8a8ef19911b1301f Mon Sep 17 00:00:00 2001 From: Martin Pokorny <89339813+mPokornyETM@users.noreply.github.com> Date: Wed, 18 Jan 2023 07:52:51 +0100 Subject: [PATCH 3/3] Update pull-request-template.md --- .../pull-request-template.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md index 81047c2..4e8f88b 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md @@ -39,7 +39,10 @@ At minimum this should include proof that a computer has executed the changed li Ideally this should include an automated test or an explanation as to why this change has no tests. Note that automated test coverage is less than complete, so a successful PR build does not necessarily imply that a computer has executed the changed lines. If automated test coverage does not exist for the lines you are changing, **you must describe** the scenario(s) in which you manually tested the change. +Currently is not possible to start automatic tests on every PR. Therefore provide the tests manually and paste the result (screenshot) here. + For frontend changes, include screenshots of the relevant page(s) before and after the change. + For refactoring and code cleanup changes, exercise the code before and after the change and verify the behavior remains the same. --> @@ -75,16 +78,15 @@ N/A Before the changes are marked as `ready-for-merge`: - - [ ] Changelog entries in the **pull request title** and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood. - -- [ ] If the change needs additional upgrade steps from users, the `upgrade-guide-needed` label is set and there is a **Proposed upgrade guidelines** section in the pull request title (see [example](...)). - [ ] C++ and Control(++) code changes are tested by automated test. - [ ] WinCC OA guidelines for C++ and Control(++) coding have been met. - [ ] Result of pipeline build proving error/warning free code. - [ ] Result of automatic tests proving regression free. + +