-
Notifications
You must be signed in to change notification settings - Fork 64
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 templates #477
Comments
I like the PR template from the odo repo. We can borrow heavily from it and have something like this: What does this PR do?: Which issue(s) this PR fixes: PR acceptance criteria:
How to test changes / Special notes to the reviewer: |
Summary of discussions with the team:
Suggestions below: PR template For the api/library repos:What does this PR do?:Summarize the changes Which issue(s) this PR fixes:Link to github issue(s) PR acceptance criteria:Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.
How to test changes / Special notes to the reviewer:PR template For the Registry:.....Similar to above but criteria is different. I'm not sure if we have client impacts with the registry but I left the criteria in there just in case:
|
The PR template for api/library looks ok. For registry one, we should focus on the requirements for the onboarding/updating of devfile in the registry, e.g. run through the steps in https://github.com/devfile/registry/blob/main/CONTRIBUTING.md. @johnmcollier @GeekArthur Anything else that needs to add, e.g.
We can probably add those missing info to the contributing.md to have a single place to contain all the onboarding information and the PR just point to that. |
The api and library repos are done. I'll re-assign this to @GeekArthur and @johnmcollier so they can take care of the registry repos |
We should update our PR templates to include a checklist of deliverables beyond the code fix/feature itself i.e. test automation, doc updates, impacts to other dependencies, etc.
This template should be consistent across our repos
The text was updated successfully, but these errors were encountered: