Skip to content

Commit

Permalink
doc : Use GitHub recommended keywords in pull request template to aut…
Browse files Browse the repository at this point in the history
…omatically link related issues (#4488)

+ Use `Fixes #N` keyword (without any formatting) in pull request
  template so that GitHub links pull request with issue automatically.
+ Merge some components from Eclipse JKube Pull Request template
+ Move pull request hints to comment blocks (They would still be visible to
  pull request authors when drafting pull requests)

Signed-off-by: Rohan Kumar <[email protected]>
  • Loading branch information
rohanKanojia authored and gbraad committed Nov 28, 2024
1 parent 8a1d173 commit 8ee8e71
Showing 1 changed file with 37 additions and 6 deletions.
43 changes: 37 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,40 @@
## Description

**Fixes:** Issue #N
<!--
Thank you for your pull request (PR)!
**Relates to:** Issue #N, PR #N, ...
Please provide a description of what your PR does providing a link (if applicable) to the issue it fixes.
-->

## Solution/Idea
Fixes: #N

Describe in plain English what you solved and how. For instance, _Added `start` command to CRC so the user can create a VM and set-up a single-node OpenShift cluster on it with one command. It requires blablabla..._
Relates to: #N, PR #N, ...

## Proposed changes
<!--
Describe in plain English what you solved and how. For instance, _Added `start` command to CRC so the user can create a VM and set up a single-node OpenShift cluster on it with one command. It requires blablabla..._
-->

## Type of change
<!--
What types of changes does your code introduce? Put an `x` in all the boxes that apply
-->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change
- [ ] Chore (non-breaking change which doesn't affect codebase;
test, version modification, documentation, etc.)

## Proposed changes
<!--
List main as well as consequential changes you introduced or had to introduce.
1. Add `start` command.
2. Add `setup` as prerequisite to `start`.
3. ...
-->

## Testing

<!--
What is the _bottom-line_ functionality that needs testing? Describe in pseudo-code or in English. Use verifiable statements that tie your changes to existing functionality.
1. `start` succeeds first time after `setup` succeeded
Expand All @@ -26,3 +44,16 @@ What is the _bottom-line_ functionality that needs testing? Describe in pseudo-c
5. `status` returns ... if `start` failed
6. `start` fails after `start` succeeded or after `status` says CRC is `Running`
7. ...
-->

## Contribution Checklist
- [ ] I have read the [contributing guidelines](https://github.com/crc-org/crc/blob/main/developing.adoc)
- [ ] My code follows the style guidelines of this project
- [ ] I Keep It Small and Simple: The smaller the PR is, the easier it is to review and have it merged
- [ ] I have performed a self-review of my code
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] I tested my code on specified platforms <!-- Only put an `x` in applicable platforms -->
- [ ] Linux
- [ ] Windows
- [ ] MacOS

0 comments on commit 8ee8e71

Please sign in to comment.