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 templates #477

Closed
kim-tsao opened this issue Jun 1, 2021 · 4 comments
Closed

Update PR templates #477

kim-tsao opened this issue Jun 1, 2021 · 4 comments
Assignees
Labels
area/releng Release engineering

Comments

@kim-tsao
Copy link
Contributor

kim-tsao commented Jun 1, 2021

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

@kim-tsao kim-tsao added the area/releng Release engineering label Jun 1, 2021
@kim-tsao
Copy link
Contributor Author

kim-tsao commented Jun 3, 2021

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?:
Summarize the changes

Which issue(s) this PR fixes:
Link to github issue(s)

PR acceptance criteria:

  • Unit test
    Provide a link to the updated testcases and execution results. If unchecked, explain why it's not needed
  • Integration test
    Provide a link to the updated testcases and execution results. If unchecked, explain why it's not needed
  • Documentation
    This includes product docs and READMEs. Provide a link to the updated docs
  • Client Impact
    Do we have anything that can break our clients? If so, open a notifying issue

How to test changes / Special notes to the reviewer:


@kim-tsao kim-tsao self-assigned this Jun 3, 2021
@kim-tsao
Copy link
Contributor Author

kim-tsao commented Jun 10, 2021

Summary of discussions with the team:

  • We don't want to prevent the PR from being merged if there are missing tests and/or docs. Having a link to tracking issues is good enough if new function impacts those areas
  • PR testing requirements may differ depending on the components. Some components may have distinct unit/functional/integration testing while others have an umbrella approach - in this case, we will use the general term Test Automation instead of itemizing everything out.
  • To avoid any confusion, we will consider the scope of Integration Tests as devfile validations with our ODO and console clients i.e. tests that fall under this repo: https://github.com/devfile/integration-tests. These will be regarded as QE Integrations Tests

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.

  • Open new test/doc issues under the devfile/api repo
  • Check each criteria if:
  • There is a separate tracking issue. Add the issue link under the criteria
    or
  • test/doc updates are made as part of this PR
  • If unchecked, explain why it's not needed
  • Unit/Functional tests
    These are run as part of the PR workflow, ensure they are updated
  • QE Integration test
    Do we need to verify integration with ODO and Openshift console?
  • Documentation
    This includes product docs and READMEs.
  • Client Impact
    Do we have anything that can break our clients? If so, open a notifying issue

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:

  • Automated Tests
    These are run as part of the PR workflow
  • Documentation
    This includes product docs and READMEs.
  • Client Impact
    Do we have anything that can break our clients? If so, open a notifying issue

@elsony
Copy link
Contributor

elsony commented Jun 15, 2021

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.

  1. How to contribute/add tests of the stack?
  2. metadata requirement, e.g. arch list, name, description, website, etc.

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.

@kim-tsao
Copy link
Contributor Author

kim-tsao commented Jul 8, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/releng Release engineering
Projects
None yet
Development

No branches or pull requests

4 participants