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

First draft of PR template #4278

Merged
merged 4 commits into from
Sep 23, 2024
Merged

First draft of PR template #4278

merged 4 commits into from
Sep 23, 2024

Conversation

bmorelli25
Copy link
Member

Description

This is a first draft of PR template. The Serverless/Stateful section is a bit long. Thoughts?

@bmorelli25 bmorelli25 requested a review from a team as a code owner September 19, 2024 23:43
Copy link
Contributor

mergify bot commented Sep 19, 2024

This pull request does not have a backport label. Could you fix it @bmorelli25? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Sep 19, 2024
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

What do you think about something like this? This approach would:

  • Prompt the author to specify which documentation set they are editing.
  • Prompt the author to link to either a port PR or tracking issue rather than giving them the option to either open a PR or add a label. IMO an issue might be easier to track in our existing workflows (our GitHub board).
## Description
<!-- Add a description here -->

### Documentation sets edited in this PR

_Check all that apply._

- [ ] Stateful (`docs/en/observability/*`)
- [ ] Serverless (`docs/en/serverless/*`)
- [ ] Integrations Developer Guide (`docs/en/integrations/*`)
- [ ] None of the above

### Related issue
Closes # <!-- Add the issue this PR closes here -->

## Checklist

- [ ] Product/Engineering Review
- [ ] Writer Review

<!-- If you are updating the Integrations Developer Guide, you can delete this section -->
### Follow-up tasks

_Select one._

* This PR does _not_ need to be ported to another doc set because:
  - [ ] The concepts in this PR only apply to one doc set (serverless _or_ stateful)
  - [ ] The PR contains edits to both doc sets (serverless _and_ stateful)
* This PR needs to be ported to another doc set:
  - [ ] Port to stateful docs: \<link to PR or tracking issue>
  - [ ] Port to serverless docs: \<link to PR or tracking issue>

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

✨ 🐥

@bmorelli25 bmorelli25 enabled auto-merge (squash) September 23, 2024 22:36
@bmorelli25 bmorelli25 merged commit eccfa6d into main Sep 23, 2024
4 checks passed
@bmorelli25 bmorelli25 deleted the bmorelli25-patch-4 branch September 23, 2024 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants