Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: slightly improve PR template #9029

Merged
merged 2 commits into from
Apr 19, 2023
Merged

chore: slightly improve PR template #9029

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e18ffb
chore: slightly improve PR template
jaalah Apr 19, 2023
6c4a45e
chore: bold test instructions
jaalah Apr 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 28 additions & 19 deletions docs/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,45 @@
## Description 📝
**Brief description explaining the purpose of the changes**

**What does this PR do?**
## Major Changes 🔄
**List highlighting major changes**
- Change #1
- Change #2

## Preview 📷
**Include a screenshot or screen recording of the change**

**Remove this section or include a screenshot or screen recording of the change**
> **Note**: Use `<video src="" />` tag when including recordings in table

## How to test 🧪

**What are the steps to reproduce the issue or verify the changes?**
| Before | After |
| ------- | ------- |
| Content | Content |
jaalah-akamai marked this conversation as resolved.
Show resolved Hide resolved

**How do I run relevant unit or e2e tests?**
## How to test 🧪
1. How to setup test environment?
2. How to reproduce the issue (if applicable)?
3. How to verify changes?
4. How to run Unit or E2E tests?
jaalah-akamai marked this conversation as resolved.
Show resolved Hide resolved

## Commit message and pull request title format standards

**Remove this section before opening the pull request**
> **Note**: Remove this section before opening the pull request

**Make sure your PR title and commit message on squash and merge are as shown below**

`<commit type>: [JIRA-ticket-number] - <description>`

**commit types:**
`feat`: New feature for the user (not a part of the code, or ci, ...).
`fix`: Bugfix for the user (not a fix to build something, ...).
`refactor`: Restructuring existing code without changing its external behavior or visual UI. Typically to improve readability, maintainability, and performance.
`style`: General styling changes. Does not change any functionality.
`build`: Changes to the application build.
`chore`: Other changes that do not impact production code.
`ci`: Changes to the CI pipeline.
`docs`: Changes to the documentation docs.
`perf`: Performance changes.
`test`: New tests or changes to existing tests. Does not change the production code.
`change`: Only use for something that doesn’t fit in any other category.
**Commit Types:**
- `feat`: New feature for the user (not a part of the code, or ci, ...).
- `fix`: Bugfix for the user (not a fix to build something, ...).
- `refactor`: Restructuring existing code without changing its external behavior or visual UI. Typically to improve readability, maintainability, and performance.
- `style`: General styling changes. Does not change any functionality.
- `build`: Changes to the application build.
- `chore`: Other changes that do not impact production code.
- `ci`: Changes to the CI pipeline.
- `docs`: Changes to the documentation docs.
- `perf`: Performance changes.
- `test`: New tests or changes to existing tests. Does not change the production code.
- `change`: Only use for something that doesn’t fit in any other category.

**Example:** `feat: [M3-1234] - Allow user to view their login history`