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 PR checklist workflow #7699

Merged
merged 7 commits into from
Jul 15, 2024
Merged

Add PR checklist workflow #7699

merged 7 commits into from
Jul 15, 2024

Conversation

kolchfa-aws
Copy link
Collaborator

Adds a workflow that will comment with the doc repo process and assign all incoming PRs to the repo owner for triage.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Fanit Kolchina <[email protected]>
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you mark the PR ready for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly, or leave comments and editorial suggestions for you to approve, make changes, and commit yourself (let us know in a comment if you have a preference.) The doc reviewer will arrange for an editorial review.

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you mark the PR ready for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly, or leave comments and editorial suggestions for you to approve, make changes, and commit yourself (let us know in a comment if you have a preference.) The doc reviewer will arrange for an editorial review.

Signed-off-by: Fanit Kolchina <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.pull_request.number }}
body: |
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.
Copy link
Collaborator

@natebower natebower Jul 12, 2024

Choose a reason for hiding this comment

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

Should these match the GitHub labels? In other words, how will these states be apparent to the author?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Some of them do (like "In progress", "Doc review", and "Tech review"). "Editorial review" label is "Final editorial review" but I'd rather change the label if needed because the goal here is to provide some hints with minimum number of words.

Copy link
Contributor

Choose a reason for hiding this comment

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

Some of them do (like "In progress", "Doc review", and "Tech review"). "Editorial review" label is "Final editorial review" but I'd rather change the label if needed because the goal here is to provide some hints with minimum number of words.

Agreed - I changed the label.

.github/workflows/pr_checklist.yml Outdated Show resolved Hide resolved
.github/workflows/pr_checklist.yml Outdated Show resolved Hide resolved
.github/workflows/pr_checklist.yml Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Copy link
Contributor

@hdhalter hdhalter left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Signed-off-by: Fanit Kolchina <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

@kolchfa-aws kolchfa-aws merged commit 67e28b3 into main Jul 15, 2024
7 checks passed
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Jul 24, 2024
* Add PR checklist workflow

Signed-off-by: Fanit Kolchina <[email protected]>

* Assign to user instead of owner

Signed-off-by: Fanit Kolchina <[email protected]>

* Testing

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove test

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* If a PR is submitted by a doc team member, assign that member

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove test

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: [email protected] <[email protected]>
sandervandegeijn pushed a commit to sandervandegeijn/documentation-website that referenced this pull request Jul 30, 2024
* Add PR checklist workflow

Signed-off-by: Fanit Kolchina <[email protected]>

* Assign to user instead of owner

Signed-off-by: Fanit Kolchina <[email protected]>

* Testing

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove test

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* If a PR is submitted by a doc team member, assign that member

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove test

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Sander van de Geijn <[email protected]>
@kolchfa-aws kolchfa-aws deleted the pr-checklist branch November 21, 2024 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants