Skip to content

Commit

Permalink
fix: add note about severity level for restricting changes (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
gorka-sq authored Mar 15, 2024
1 parent aeabb99 commit 9978874
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -15,16 +17,19 @@ 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?

**_[RESTRICTING|EXPANDING] change**

_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_

Expand All @@ -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._

0 comments on commit 9978874

Please sign in to comment.