[GitHub] szha opened a new issue #8105: Proposal: PR Template

[gi...@git.apache.org]

szha opened a new issue #8105: Proposal: PR Template
URL: https://github.com/apache/incubator-mxnet/issues/8105
 
 
   # What
   I?d like to propose that we use PR template in MXNet. The template should consist of a checklist for the required items for merging a PR (e.g. lint and testing), as well as the items of the change (e.g. features)
   
   # Why
   It should serve two purposes:
   - It reminds both the contributor and reviewer/committers of checking the prerequisites before merging.
   - It serves as a progress tracking tool on which PRs are ready for review and merging, so that reviewer/committers 
   
   # How
   - Contributor should maintain the status of PR by checking/unchecking items in the checklist.
   - Committer should uncheck items that hasn?t been passed yet (e.g. contributor checked lint but lint failed on CI), and make comments on what more should be done. By default committers review PRs that are shown to be complete in the PR list.
   
   # FAQ
   - What if I as a contributor want to request for review of things working in progress?
   Everyone can still do what everyone is doing now: requesting reviewer to take a look by @ them.
   
   # Template
   ## Description ##
   (Brief description on what this PR is about)
   
   ## Checklist ##
   ### Essential ###
   - [ ] Passed code style checking (`make lint`)
   - [ ] Changes are complete (i.e. I finished coding on this PR)
   - [ ] All changes have test coverage
   - [ ] Examples are either not affected by this change, or have been fixed to be compatible with this change
   - [ ] For user-facing API changes, API doc string has been updated.
   
   ### Changes ###
   - [ ] Feature1, tests, (and when applicable, API doc)
   - [ ] Feature2, tests, (and when applicable, API doc)
   
   ## Comments ##
   - If this change is a backward incompatible change, why must this change be made.
   - Intersting edge cases to note here
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services