From 3360c7dddb8a098da33b58929933cbe2de2fa621 Mon Sep 17 00:00:00 2001 From: Nick Dingle Date: Tue, 23 Jan 2024 14:45:37 +0000 Subject: [PATCH] Add Merge Request templates --- .gitlab/merge_request_templates/Bugfix.md | 17 +++++++++++++++ .gitlab/merge_request_templates/Default.md | 21 +++++++++++++++++++ .../merge_request_templates/Documentation.md | 16 ++++++++++++++ 3 files changed, 54 insertions(+) create mode 100644 .gitlab/merge_request_templates/Bugfix.md create mode 100644 .gitlab/merge_request_templates/Default.md create mode 100644 .gitlab/merge_request_templates/Documentation.md diff --git a/.gitlab/merge_request_templates/Bugfix.md b/.gitlab/merge_request_templates/Bugfix.md new file mode 100644 index 0000000..bea5b43 --- /dev/null +++ b/.gitlab/merge_request_templates/Bugfix.md @@ -0,0 +1,17 @@ +## Description + +This template is intended for Merge Requests that fix a bug in the library. + +If an [Issue](https://gitlab.arm.com/networking/ral/-/issues) already exists for this bug, please provide a link to the Issue here. If an [Issue](https://gitlab.arm.com/networking/ral/-/issues) does not exist, please provide information on how to reproduce the bug here. + +## Checklist + +* [] [Contribution meets RAL's licence terms](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-licensing-information) +* [] [Documentation updated](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-documentation) +* [] [`clang-format` and `clang-tidy` run and changes included (C/C++ code)](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-cc-code-style) +* [] [`flake8` run and changes included (Python code)](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-python-code-style) +* [] Commit message includes information on how to reproduce the issue(s) +* [] [Tests added or updated](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-writing-tests) +* [] [Tests pass when run with AddressSanitizer](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md?ref_type=heads#user-content-testing-with-addresssanitizer) + +For any items that are not checked, please provide details. diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md new file mode 100644 index 0000000..656f1d8 --- /dev/null +++ b/.gitlab/merge_request_templates/Default.md @@ -0,0 +1,21 @@ +## Description + +This template is intended for general Merge Requests that add or change library functionality. + +Summarize the purpose of this Merge Request here. See the [contribution guidelines](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md) for more details. + +If this Merge Request addresses an [Issue](https://gitlab.arm.com/networking/ral/-/issues) that has already been raised, please provide a link to the Issue here. If an [Issue](https://gitlab.arm.com/networking/ral/-/issues) does not exist, please provide information on how to reproduce the problem here. + +## Checklist + +* [] [Contribution meets RAL's licence terms](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-licensing-information) +* [] [New functions adhere to RAL's naming scheme](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-function-naming) +* [] [Contribution conforms to RAL's directory structure](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-directory-structure) +* [] [Documentation updated](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-documentation) +* [] [`clang-format` and `clang-tidy` run and changes included (C/C++ code)](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-cc-code-style) +* [] [`flake8` run and changes included (Python code)](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-python-code-style) +* [] [Tests added or updated](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-writing-tests) +* [] [Tests pass when run with AddressSanitizer](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md?ref_type=heads#user-content-testing-with-addresssanitizer) +* [] [Benchmarks added or updated](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-writing-benchmarks) + +For any items that are not checked, please provide details. diff --git a/.gitlab/merge_request_templates/Documentation.md b/.gitlab/merge_request_templates/Documentation.md new file mode 100644 index 0000000..249b11b --- /dev/null +++ b/.gitlab/merge_request_templates/Documentation.md @@ -0,0 +1,16 @@ +## Description + +This template is intended for documentation-only changes. + +Summarize the purpose of this Merge Request here. See the [contribution guidelines](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md) for more details. + +If this Merge Request addresses an [Issue](https://gitlab.arm.com/networking/ral/-/issues) that has already been raised, please provide a link to the Issue here. If an [Issue](https://gitlab.arm.com/networking/ral/-/issues) does not exist, please provide information on how to reproduce the problem here. + +## Checklist + +* [] [Contribution meets RAL's licence terms](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-licensing-information) +* [] [`make docs` target runs successfully](https://gitlab.arm.com/networking/ral/-/blob/main/README.md?ref_type=heads#user-content-documentation) +* [] [`clang-format` and `clang-tidy` run and changes included (C/C++ code)](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-cc-code-style) +* [] [`flake8` run and changes included (Python code)](https://gitlab.arm.com/networking/ral/-/blob/main/CONTRIBUTING.md#user-content-python-code-style) + +For any items that are not checked, please provide details. -- GitLab