This is an automated email from the ASF dual-hosted git repository.
hemant pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone.git
The following commit(s) were added to refs/heads/master by this push:
new f2db9cebba HDDS-9363. Updated pull request template to remove PR title
confusion (#5483)
f2db9cebba is described below
commit f2db9cebbaa496d90ba3dcbce77d8ae484b106ee
Author: Hemant Kumar <[email protected]>
AuthorDate: Wed Oct 25 15:13:09 2023 -0700
HDDS-9363. Updated pull request template to remove PR title confusion
(#5483)
---
.github/pull_request_template.md | 28 ++++++++++++++++++----------
1 file changed, 18 insertions(+), 10 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index a7c6aa8fd0..34aaf9b8cf 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -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)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
