From 99788746845c79e9e7239edd49df1286a9e38a5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gorka=20L=C3=B3pez=20de=20Torre?= <144118333+gorka-sq@users.noreply.github.com> Date: Fri, 15 Mar 2024 09:08:16 +0100 Subject: [PATCH] fix: add note about severity level for restricting changes (#23) --- .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9f50eed..864a310 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,6 +6,8 @@ Here are some friendly reminders before submitting your pull request: - There should be a goal describing the motivation for this change. - Consider if this change is restricting current style or expanding it. +- Changes should be discussed with the team before being accepted. +- Restricting changes should have [severity level `info`](https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Severity) to allow time for adoption before making them mandatory. YOU CAN REMOVE THE PARTS OF THE TEMPLATE THAT DO NOT APPLY TO YOUR PULL REQUEST @@ -15,7 +17,7 @@ YOU CAN REMOVE THE PARTS OF THE TEMPLATE THAT DO NOT APPLY TO YOUR PULL REQUEST ### What is the goal? -_Provide a description of the overall goal (you can usually use the one from the issue)_ +_Provide a description of the overall goal._ ### Is this a restricting or expanding change? @@ -23,8 +25,11 @@ _Provide a description of the overall goal (you can usually use the one from the _Restricting changes are those that limit the current style or add new rules, while expanding changes are those that remove rules or relax the current ones._ +_Changes should be discussed with the team before being accepted._ + +_Restricting changes should have [severity level `info`](https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Severity) to allow time for adoption before making them mandatory._ + ### References -* **Issue:** _jira issue goes here, if suggesting a new feature or change, please discuss it in an issue first_ * **Related pull-requests:** _list of related pull-requests (comma-separated): #1, #2_ * **Any other references:** _list of links to other references (comma-separated): link1, link2_ @@ -39,9 +44,3 @@ _Have you improved the code/app in anyway? Explain what you did._ ### Caveats _If you find any, please describe all the special conditions._ - -### How is it tested? - -_Automatic tests? Manual tests?_ - -_If it cannot be tested explain why._