add PR template to repo

[a-mccarthy]

Signed-off-by: Abigail McCarthy mabigail@vmware.com

Opening this PR as a Draft to start a discussion on adding a PR template to the repo. I'm not sure if this has come up before, but I think these templates can be very helpful to make sure folks fill in some basic info about what the PR is for and remind folks to do the required steps to get the PR merged that can get missed, like the DCO.

I'd also like to make sure we call out updating docs now that the docs are kept in a separate repo.

Is there anything else we should call out here? Like for creating release notes or how to run/pass tests?

[a-mccarthy]

cc: @xaleeks

[codecov]

Codecov Report

Merging #14271 (93bdf8b) into master (dfe3600) will increase coverage by 2.85%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #14271      +/-   ##
==========================================
+ Coverage   62.71%   65.57%   +2.85%     
==========================================
  Files         913      925      +12     
  Lines       61050    69462    +8412     
  Branches     2018     2101      +83     
==========================================
+ Hits        38287    45547    +7260     
- Misses      18828    19964    +1136     
- Partials     3935     3951      +16     

Flag	Coverage Δ
unittests	65.57% <ø> (+2.85%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/pkg/notification/notification.go	30.76% <0.00%> (-51.84%)	⬇️
src/lib/q/query.go	56.66% <0.00%> (-43.34%)	⬇️
src/controller/quota/options.go	71.42% <0.00%> (-28.58%)	⬇️
...portal/src/app/services/skinable-config.service.ts	54.54% <0.00%> (-25.46%)	⬇️
src/pkg/scan/dao/scanner/registration.go	58.33% <0.00%> (-21.67%)	⬇️
...av/replication/total-replication-page.component.ts	44.82% <0.00%> (-18.81%)	⬇️
src/common/api/base.go	46.42% <0.00%> (-17.86%)	⬇️
src/controller/quota/controller.go	43.53% <0.00%> (-14.29%)	⬇️
src/common/dao/repository.go	62.50% <0.00%> (-13.62%)	⬇️
src/pkg/task/execution.go	62.50% <0.00%> (-8.78%)	⬇️
... and 331 more

[steven-zou]

Maybe we can add some other items like testing passed or testing coverage etc. into this checklist?

Or just let the user make sure the CI pipeline is passed?

[yanji09]

Thanks Abbie for creating the template. Assuming this one is for those PRs need document change. If the PR doesn't need document change, how submitter make the choice. And it would be better to change the document after this PR is merged.
One suggestion is to make it as a note only.

[a-mccarthy]

Thats a good point. My first goal is to remind folks about updating the docs. I think my concern with making it a note, instead of a check mark is that there is no sign-off from a contributor.

What if we made it more open ended? something like,

- [ ] Considered the docs impact and opened a new docs issue or PR with docs changes if needed

My concern is that if we merge a PR without an option like this as a part of the checklist, then there will be no way to remember to open and docs issue or PR after the pr is merged. I'm interested to hear thoughts and feedback on this idea

[yanji09]

LGTM