Skip to content
This repository has been archived by the owner on Jul 23, 2024. It is now read-only.

Add Pull Request template #268

Merged
merged 1 commit into from
Apr 26, 2023

Conversation

nirarg
Copy link
Contributor

@nirarg nirarg commented Apr 20, 2023

I open this PR as suggestion and discussion about what should be our guidelines for Pull Requests

The purpose of this template is to provide the author with a clearer set of instructions on the necessary steps to follow in order to create a proper pull request. As a result, the review process will be streamlined and more effective.

@nirarg nirarg force-pushed the pull-request branch 2 times, most recently from adb7320 to e486b0c Compare April 20, 2023 07:31
@eloycoto
Copy link
Collaborator

I'm not sure if this helps at all, my experience is:

  • At the moment, we don't even force good commits. So, IMHO, we're far away from writing good PR descriptions.
  • The templates, in my experience, only help to have a placeholder that no one uses.

- [ ] New feature
- [ ] Bug fix

**Impacted elements**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd merge this one with the above

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

- [ ] Unit tests
- [ ] Integration tests
- [ ] CI
- [ ] Docs
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Docs/Documentation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Comment on lines 32 to 33
- [ ] `mvn clean install` was executed to validate changes
- [ ] Integration tests were validated with the change
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two will be run by the CI, I don't think there is a need to check them manually

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But it can be good reminder for the Author, before the PR is opened

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is implied by **Impacted elements** section

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I see it, **Impacted elements** indicates if the element code was changed (i.e. changed integration test)
But even if the integration code is not changed, it need to be validated

Any way, I'm flexible on this matter and it can be eliminated to simplify the template.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed those lines

@nirarg
Copy link
Contributor Author

nirarg commented Apr 20, 2023

I'm not sure if this helps at all, my experience is:

  • At the moment, we don't even force good commits. So, IMHO, we're far away from writing good PR descriptions.
  • The templates, in my experience, only help to have a placeholder that no one uses.

I think this is a good thing to start with
And this is our responsibility as a group to enforce this (if we think it may help)

@rgolangh
Copy link
Contributor

I would take this and put it as the start of CONTRIBUTING.md and consider making this template bit more concise.
Doesn't have to be in this PR because it is a good improvement from what we have now.

@rgolangh
Copy link
Contributor

I'm not sure if this helps at all, my experience is:

  • At the moment, we don't even force good commits. So, IMHO, we're far away from writing good PR descriptions.
  • The templates, in my experience, only help to have a placeholder that no one uses.

I think this is a good thing to start with And this is our responsibility as a group to enforce this (if we think it may help)

I'm not sure if this helps at all, my experience is:

  • At the moment, we don't even force good commits. So, IMHO, we're far away from writing good PR descriptions.
  • The templates, in my experience, only help to have a placeholder that no one uses.

I think this is a good thing to start with And this is our responsibility as a group to enforce this (if we think it may help)

in time if this is just a burden we can narrow this down


**What this PR does / why we need it**:

**Which issue(s) this PR fixes** *(optional, use `fixes #<issue_number>(, fixes #<issue_number>, ...)` format, where issue_number might be a GitHub issue, or a Jira story*:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we can put "FLPATH-xxxx " as an example to what we expect

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added

@rgolangh
Copy link
Contributor

@nirarg since you suggested it and there's some debate around it - can you take revisit this with the team in say 2 weeks, 1 month from now?

Copy link
Collaborator

@pkliczewski pkliczewski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is an example how assisted installer team defined a template.

The purpose of this template is to provide the author with a clearer
set of instructions on the necessary steps to follow in order to create
a proper pull request. As a result, the review process will be
streamlined and more effective.
Copy link
Collaborator

@pkliczewski pkliczewski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@masayag
Copy link
Collaborator

masayag commented Apr 25, 2023

/lgtm

not yet approving to allow others to add their comments.

@openshift-ci
Copy link

openshift-ci bot commented Apr 26, 2023

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by:

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit 5e2d0a6 into parodos-dev:main Apr 26, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants