Skip to content
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.

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

Update PR template #3129

Merged
merged 2 commits into from
Jul 12, 2021
Merged

Update PR template #3129

merged 2 commits into from
Jul 12, 2021

Conversation

jantonguirao
Copy link
Contributor

@jantonguirao jantonguirao commented Jul 6, 2021

Description

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactoring (Redesign of existing code that doesn't affect functionality)
  • Other (e.g. Documentation, Tests, Configuration)

Describe in detail what happened in this PR

Fill extra details, if applicable

  • What solution was applied?:
  • Affected modules and functionalities:
  • Key points relevant for the review:

Checklist

Tests

  • Existing tests apply
  • New tests added
    • Python tests
    • GTests
    • Benchmark
    • Other
  • N/A

Documentation

  • Existing documentation applies
  • Documentation updated
    • Docstring
    • Doxygen
    • RST
    • Jupyter
    • Other
  • N/A

DALI team only

Requirements

  • Implements new requirements
  • Affects existing requirements
  • N/A

REQ IDs: N/A

JIRA TASK: N/A

@jantonguirao jantonguirao force-pushed the pr-templ-update branch 6 times, most recently from 6a4fa1f to bfc771e Compare July 6, 2021 15:36
Comment on lines 28 to 30
- [ ] Implements new requirements
- [ ] N/A
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [ ] Implements new requirements
- [ ] N/A
- [ ] Implements new requirements
- [ ] Affects existing requirements
- [ ] N/A

@JanuszL JanuszL requested review from a team and removed request for a team July 6, 2021 17:16
@jantonguirao jantonguirao changed the title [WIP] Update PR template Update PR template Jul 7, 2021
@jantonguirao jantonguirao marked this pull request as ready for review July 7, 2021 09:11

- [ ] Existing documentation apply
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [ ] Existing documentation apply
- [ ] Existing documentation applies

However, it would be nice to have some more boxes (Docstrings, Doxygen, RST, Ohter).

Comment on lines 36 to 42
- [ ] Existing tests apply
- [ ] New tests added
- [ ] N/A
Copy link
Contributor

Choose a reason for hiding this comment

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

Python tests / GTest / Benchmark?
If we have checkboxes it seems cheap to add them.

@jantonguirao jantonguirao force-pushed the pr-templ-update branch 3 times, most recently from ded5f9c to c976281 Compare July 7, 2021 11:12
Signed-off-by: Joaquin Anton <janton@nvidia.com>
@klecki
Copy link
Contributor

klecki commented Jul 12, 2021

In my opinion:

  • too long.
  • first two sections duplicate each other, if I have to tick it, some people will remove it probably, and than we have to describe the same thing again using our own words. The amount of text in them is intimidating and discouraging from reading it.
  • If we are already touching this the
*[ Explain solution of the problem, a new feature added here. ]*

Is the most awkward and annoying part for me for a long time. If you leave the *[ ]* the formatting gets weird. They are indented, but I think few new-lines would be easy to just copy&paste stuff from commit description. Also this filler text should be a comment so it's only visible when editing.

The checklist is fine, but I think it should have some explanation for the external contributors. Especially the requirements stuff and JIRA task, maybe it should be moved to some DALI Team only section?

@jantonguirao jantonguirao assigned klecki and unassigned banasraf Jul 12, 2021
Signed-off-by: Joaquin Anton <janton@nvidia.com>
@jantonguirao jantonguirao merged commit 4251e7c into NVIDIA:main Jul 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants