Skip to content

HDDS-9363. Updated pull request template to remove PR title confusion #5483

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

Merged
hemantk-12 merged 2 commits into from
Oct 25, 2023
Merged

HDDS-9363. Updated pull request template to remove PR title confusion #5483

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30a1fda
Updated pull request template
hemantk-12 Oct 24, 2023
f98737c
Addressed review comments
hemantk-12 Oct 24, 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
28 changes: 18 additions & 10 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
## What changes were proposed in this pull request?
Provide a one-liner summary of the changes in the PR **Title** field above.
It should be in the form of `HDDS-1234. Short summary of the change`.

(Please fill in changes proposed in this fix
1. **Title:** Title should provide a one sentence overview of the purpose of the PR.
2. **Description:**
* What changes are proposed in the PR? and Why? It would be better if it is written from third person's perspective not just for the reviewer.
* Provide as much context and rationale for the pull request as possible. It could be copy-paste from the Jira's description if the jira is well defined.
* If it is complex code, describe the approach used to solve the issue. If possible attach design doc, issue investigation, github discussion, etc.
3. **PR examples:** [PR#3980](https://github.com/apache/ozone/pull/3980), [PR#5265](https://github.com/apache/ozone/pull/5265), [PR#4701](https://github.com/apache/ozone/pull/4701), [PR#5283](https://github.com/apache/ozone/pull/5283), [PR#5300](https://github.com/apache/ozone/pull/5300))
Please describe your PR in detail:
* What changes are proposed in the PR? and Why? It would be better if it is written from third person's
perspective not just for the reviewer.
* Provide as much context and rationale for the pull request as possible. It could be copy-paste from
the Jira's description if the jira is well defined.
* If it is complex code, describe the approach used to solve the issue. If possible attach design doc,
issue investigation, github discussion, etc.

Examples of well-written pull requests:
* [#3980](https://github.com/apache/ozone/pull/3980)
* [#5265](https://github.com/apache/ozone/pull/5265)
* [#4701](https://github.com/apache/ozone/pull/4701)
* [#5283](https://github.com/apache/ozone/pull/5283)
* [#5300](https://github.com/apache/ozone/pull/5300)

## What is the link to the Apache JIRA

(Please create an issue in ASF JIRA before opening a pull request,
and you need to set the title of the pull request which starts with
the corresponding JIRA issue number. (e.g. HDDS-XXXX. Fix a typo in YYY.)
Please create an issue in ASF JIRA before opening a pull request, and you need to set the title of the pull
request which starts with the corresponding JIRA issue number. (e.g. HDDS-XXXX. Fix a typo in YYY.)

(Please replace this section with the link to the Apache JIRA)

Expand Down