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

add workflow description section to the template #1090

Merged

Conversation

dhellmann
Copy link
Contributor

Add a new section to the enhancement template to encourage enhancement
authors to explain how someone will use the feature they are
describing.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 18, 2022
@dhellmann
Copy link
Contributor Author


See
https://github.com/openshift/enhancements/blob/master/enhancements/workload-partitioning/management-workload-partitioning.md#high-level-end-to-end-workflow
and https://github.com/openshift/enhancements/pull/1067 for more detailed examples.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll keep this PR a WIP until the second example here is merged and I can link to the published version of the doc.

guidelines/enhancement_template.md Outdated Show resolved Hide resolved
guidelines/enhancement_template.md Outdated Show resolved Hide resolved
Copy link
Contributor

@kikisdeliveryservice kikisdeliveryservice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: how do these sections/changes apply if the enhancement isn't user facing?

@dhellmann
Copy link
Contributor Author

q: how do these sections/changes apply if the enhancement isn't user facing?

I would be surprised to find us making changes for which the user will neither provide input nor see any impact. Do you have an example in mind?

@dhellmann dhellmann removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 27, 2022
@dhellmann
Copy link
Contributor Author

Rebased and removed the WIP label

@dhellmann dhellmann changed the title WIP: add workflow description section to the template add workflow description section to the template Apr 27, 2022
@dhellmann
Copy link
Contributor Author

/hold

We still want to wait on this to update it after the linked example in #1067 is merged.

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 27, 2022
Be explicit about the expectation that user stories are written using
a formula.

Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
Add a new section to the enhancement template to encourage enhancement
authors to explain how someone will use the feature they are
describing.

Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
Copy link
Contributor Author

/hold cancel

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 4, 2022
@dhellmann
Copy link
Contributor Author

@bparees @kikisdeliveryservice this should be ready to go now

@bparees
Copy link
Contributor

bparees commented May 5, 2022

/approve
/lgtm
/hold
(in case you want more feedback)

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 5, 2022
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 5, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented May 5, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bparees

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 5, 2022
@dhellmann
Copy link
Contributor Author

/hold cancel

Let's move along. We can tweak further if we need to.

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 6, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented May 6, 2022

@dhellmann: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@openshift-merge-robot openshift-merge-robot merged commit 0b71ab6 into openshift:master May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants