Skip to content

Commit

Permalink
Addng a PR Template
Browse files Browse the repository at this point in the history
This template should contain all required information we want on a cop PR.
  • Loading branch information
piyushswain committed Aug 1, 2023
1 parent 7b7e07b commit 62d1bda
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
**Replace this text with a summary of the changes in your PR.
The more detailed you are, the better.**

-----------------
Severity:
[ ] - info
[ ] - refactor
[X] - convention (default)
[ ] - warning
[ ] - error
[ ] - fatal
-----------------

**Wrong Code**

```rb
# Replace with an example of offending code for the cop. You can have multiple examples also.
```

**Correct Code**

```rb
# Replace with the expected correct code if the cop has an autocorrect. Else remove this part.
```

-----------------

**Solidus PR Link:** # Replace with link to Solidus PR where the change has been made.

-----------------

**Before submitting the PR make sure the following are checked:**

* [ ] The PR relates to *only* one cop with a clear title and description.
* [ ] Feature branch is up-to-date with `master` (if not - rebase it).
* [ ] Squashed related commits together.
* [ ] Added tests.
* [ ] Ran and ensured all tests are passing on a development environment.
* [ ] If this is a new cop, added an entry for the cop on `/config/default.yml`

0 comments on commit 62d1bda

Please sign in to comment.