Skip to content

Commit

Permalink
feat: update pr template
Browse files Browse the repository at this point in the history
  • Loading branch information
rsaz committed Apr 27, 2024
1 parent 48a1f92 commit bd1838a
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@

Our guidelines for submitting a pull request.

## Before submitting a Pull Request, please make sure you have verified the following:
## Before submitting your PR, please verify the following:

- [ ] The commit message follows our guidelines:
- A good commit message should be two things: meaningful and concise. It should not contain every single detail, describing each changed line—we can see all the changes in Git—but, at the same time, it should say enough to avoid ambiguity.
- We use Microverse's commit message convention
- The convention stablish that a commit message has to be in the present tense, imperative and lowercase.
- Example: `fix typo in README.md`

> Make sure you prefix your commit message with the type of change you are making. Your commit message should look like this: `type: description of the change`.
>
> - Fixing a bug : `fix: description of the change`.
> - Adding a new feature : `feat: description of the change`.
See the options for the different types of changes you can make in the `package.json` file of your project.

**Leave the options below unchecked if they are not applicable to your Pull Request.**

- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)

Expand All @@ -17,31 +23,28 @@ Our guidelines for submitting a pull request.
What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] Test
- [ ] Other... Please describe:

## What is the current behavior?

Please describe the current behavior that you are modifying, or link to a relevant issue.

Issue Number: N/A

## What is the new behavior?

Describe the new behavior or link to a relevant issue.

## Does this PR introduce a breaking change?

- [ ] Yes
- [ ] No

If this PR contains a breaking change, please describe the impact and migration path for existing applications below.
If `yes` Please describe the impact and mitigation strategy for existing applications.

## What was changed?

Please describe what you have changed in this PR.

## Other information

Any other information that is important to this PR.
Any other information that is important to this PR.

0 comments on commit bd1838a

Please sign in to comment.