-
Notifications
You must be signed in to change notification settings - Fork 27
Conversation
adb7320
to
e486b0c
Compare
I'm not sure if this helps at all, my experience is:
|
.github/pull_request_template.md
Outdated
- [ ] New feature | ||
- [ ] Bug fix | ||
|
||
**Impacted elements** |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
.github/pull_request_template.md
Outdated
- [ ] Unit tests | ||
- [ ] Integration tests | ||
- [ ] CI | ||
- [ ] Docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/Docs/Documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
.github/pull_request_template.md
Outdated
- [ ] `mvn clean install` was executed to validate changes | ||
- [ ] Integration tests were validated with the change |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed those lines
I think this is a good thing to start with |
I would take this and put it as the start of CONTRIBUTING.md and consider making this template bit more concise. |
in time if this is just a burden we can narrow this down |
.github/pull_request_template.md
Outdated
|
||
**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*: |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added
@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? |
There was a problem hiding this 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/lgtm not yet approving to allow others to add their comments. |
[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 |
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.