Skip to content

Commit

Permalink
docs: add a pull request template (#728)
Browse files Browse the repository at this point in the history
- Pull request template to help contributors avoid common
  omissions when submitting pull requests.

Signed-off-by: Scott Wickersham <swickers@redhat.com>
  • Loading branch information
swickersh authored Dec 6, 2024
1 parent 2fc609f commit ff5523d
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,26 @@ Overall explanation of what this commit is achieving and the motivation behind i
Signed-off-by: Your Name <your-name@your-email.com>
```
### Pull Request Title Prefixes

The title prefix should be one of (`chore`|`docs`|`feat`|`fix`|`refactor`|`revert`|`style`|`test`) followed by a colon (`:`) and lowercase title. Optionally, you can include a Jira key.

Examples:

- fix(KFLUXSPRT-794): pass content-gateway token
- feat: add rpms-signature-scan task

Title prefixes:

- **chore**: Changes that do not modify functionality (e.g., version bumps, tool updates, or maintenance tasks).
- **docs**: Documentation updates or additions (e.g., README changes, inline comments).
- **feat**: Introduction of a new feature or functionality.
- **fix**: Bug fixes or corrections to existing functionality.
- **refactor**: Code changes that improve structure or readability without altering functionality.
- **revert**: Reverting a previous commit or pull request.
- **style**: Code formatting or stylistic changes that do not affect functionality (e.g., whitespace, linting).
- **test**: Adding or updating tests (e.g., unit tests, integration tests).


### Pull Requests

Expand Down
11 changes: 11 additions & 0 deletions pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Describe your changes

## Relevant Jira

## Checklist before requesting a review
- [ ] I have marked as draft or added `do not merge` label if there's a dependency PR
- If you want reviews on your draft PR, you can add reviewers or add the `release-service-maintainers` handle if you are unsure who to tag
- [ ] My commit message includes `Signed-off-by: My name <email>`
- [ ] I have bumped the task/pipeline version string and updated changelog in the relevant README
- [ ] I read CONTRIBUTING.MD and [commit formatting](CONTRIBUTING.md#commit-message-formatting-and-standards)

0 comments on commit ff5523d

Please sign in to comment.