Add PR template (#203)

* Refs #20414: Add PR template Signed-off-by: JesusPoderoso <[email protected]> * Refs #20414: Apply rev suggestions Signed-off-by: JesusPoderoso <[email protected]> * Refs #20414: Apply rev suggestions (2) Signed-off-by: JesusPoderoso <[email protected]> --------- Signed-off-by: JesusPoderoso <[email protected]>
eProsima · Jul 9, 2024 · 88d524b · 88d524b
1 parent 24d9e72
commit 88d524b
Showing 1 changed file with 50 additions and 0 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,50 @@
+<!-- Provide a general summary of your changes in the Title above -->
+<!-- It must be meaningful and coherent with the changes -->
+
+<!--
+ If this PR is still a Work in Progress [WIP], please open it as DRAFT.
+ Please consider if any label should be added to this PR.
+-->
+
+## Description
+<!--
+ Describe changes in detail.
+ This includes depicting the context, use case or current behavior and describe the proposed changes.
+ If several features/bug fixes are included with these changes, please consider opening separated pull requests.
+-->
+
+<!--
+ In case of bug fixes, please provide the list of supported branches where this fix should be also merged.
+ Please uncomment following line, adjusting the corresponding target branches for the backport.
+-->
+<!-- @Mergifyio backport 2.2.x 1.1.x 1.0.x -->
+
+<!-- If an issue is already opened, please uncomment next line with the corresponding issue number. -->
+<!-- Fixes #(issue) -->
+
+<!-- In case the changes are built over a previous pull request, please uncomment next line. -->
+<!-- This PR depends on #(PR) and must be merged after that one. -->
+
+## Contributor Checklist
+
+<!--
+ - If any of the elements of the following checklist is not applicable, substitute the checkbox [ ] by _N/A_:
+ - If any of the elements of the following checklist is not fulfilled on purpose, please provide a reason and substitute the checkbox [ ] with ❌: or __NO__:.
+-->
+
+- [ ] Commit messages follow the project guidelines. <!-- External contributors should sign the DCO. Fast DDS developers must also refer to the internal Redmine task. -->
+- [ ] The code follows the style guidelines of this project. <!-- Please refer to the [Quality Declaration](https://github.com/eProsima/Fast-CDR/blob/master/QUALITY.md#linters-and-static-analysis-4v) for more information. -->
+- [ ] Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally <!-- Blackbox tests checking the new functionality are required. Changes that add/modify public API must include unit tests covering all possible cases. In case that no tests are provided, please justify why. -->
+- [ ] Any new/modified methods have been properly documented using Doxygen. <!-- Even internal classes, and private methods and members should be documented, not only the public API. -->
+- [ ] Changes are ABI compatible. <!-- Bug fixes should be ABI compatible if possible so a backport to previous affected releases can be made. -->
+- [ ] Changes are API compatible. <!-- Public API must not be broken within the same major release. -->
+- [ ] New feature has been added to the `versions.md` file (if applicable).
+- [ ] Applicable backports have been included in the description.
+
+## Reviewer Checklist
+
+- [ ] The PR has a milestone assigned.
+- [ ] The title and description correctly express the PR's purpose.
+- [ ] Check contributor checklist is correct.
+- [ ] Check CI results: changes do not issue any warning.
+- [ ] Check CI results: CI pass and failing tests are unrelated with the changes.