Skip to content

HDDS-9363. Added jira guideline and updated Pull request template #5372

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
merged 1 commit into from
Oct 15, 2023
Merged

HDDS-9363. Added jira guideline and updated Pull request template #5372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 10 additions & 4 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
## What changes were proposed in this pull request?

(Please fill in changes proposed in this fix)
(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))

## 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 replace this section with the link to the Apache JIRA)
(Please replace this section with the link to the Apache JIRA)

## How was this patch tested?

(Please explain how this patch was tested. Ex: unit tests, manual tests)
(If this patch involves UI changes, please attach a screen-shot; otherwise, remove this)
(Please explain how this patch was tested. Ex: unit tests, manual tests, workflow run on the fork git repo.)
(If this patch involves UI changes, please attach a screenshot; otherwise, remove this.)
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,19 @@ OZONE_REPLICATION_FACTOR=3 ./run.sh -d

See more details in the [README](https://github.com/apache/ozone/blob/master/hadoop-ozone/dist/src/main/compose/ozone/README.md) and in the [docs](https://ozone.apache.org/docs/current/start.html).

## Jira guideline

When creating a new jira for any kind of new feature, improvement or bug, please follow below guideline:

1. **Title:** Title should be a one-liner stating the problem.
2. **Description:**
* What is the problem? Is it a feature, improvement or bug? Add as many details as possible and related design doc and discussion.
* For new features, add as many details as possible. If it is part of the big feature, attach parent jira.
* For improvement, add the value it will bring. Is it an optimization, code simplification or something else?
* For bugs, add steps to reproduce it. Where the root cause is unknown and needs investigation, it would be great to update the jira description or add the summary once the root cause is identified.
* If it is follow up of another issue, please link the previous jira to it so that context is preserve.
3. **Jira examples:** [HDDS-9272](https://issues.apache.org/jira/browse/HDDS-9272), [HDDS-9322](https://issues.apache.org/jira/browse/HDDS-9322), [HDDS-9291](https://issues.apache.org/jira/browse/HDDS-9291), [HDDS-8940](https://issues.apache.org/jira/browse/HDDS-8940), [HDDS-9282](https://issues.apache.org/jira/browse/HDDS-9282)

## Contribute your modifications

We use GitHub pull requests for contributing changes to the repository. The main workflow is as follows:
Expand All @@ -101,7 +114,6 @@ We use GitHub pull requests for contributing changes to the repository. The main
* In general, please try to avoid force-push when updating the PR. Here are some great articles that explain why:
* https://developers.mattermost.com/blog/submitting-great-prs/#4-avoid-force-pushing
* https://www.freecodecamp.org/news/optimize-pull-requests-for-reviewer-happiness#request-a-review

## Code convention and tests

Basic code conventions followed by Ozone:
Expand Down