-
Notifications
You must be signed in to change notification settings - Fork 172
chore: update pull request template, add code review checklist #2043
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
chore: update pull request template, add code review checklist #2043
Conversation
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.
IMO the 28 items checklist split into 3 levels is overkill.
Can we come up with smth simple + automated as much as possible?
Also, let's make a link to workspaces.openshift.com / 'Try it on Eclipse Che hosted by Red Hat ' a requirement for easy verification e.g. - #1986
|
Feedback from Che Community call:
|
|
@ibuziuk do you have an example how to write a link to the PR to create in a PR template? It is "easy" to add afterwards when the PR exists, and we have a link, but I don't really see how to achieve that in the template. |
mmorhun
left a comment
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 completely agree that docs quality should be good, but in my opinion suggested list of requirements is too much and imprecise in some places.
Anyway, thanks to the docs team for working towards better docs and contribution process!
rkratky
left a comment
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.
@themr0c, nitpick: can we choose between "Pull Request" and "pull request", and only use one? (I vote for the latter.)
chore: updating pull request template
What does this PR do?
What issues does this PR fix or reference?
The review checklist contains not enough information.
Specify the version of the product this PR applies to
che-docs
Pull Request Checklist for committers and reviewers
The author and the reviewers validate the content of this Pull Request with this checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.