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 doc updates checklist to PR template #4551

Merged
merged 3 commits into from
Feb 19, 2025

Conversation

inancgumus
Copy link
Member

@inancgumus inancgumus commented Feb 14, 2025

What?

Adds the documentation updates checklist to the PR template.

Why?

To streamline the release process and reduce mistakes.

Notes

  • Ownership: The PR owner is responsible for making all documentation updates.
  • Mandatory documentation updates: To prevent documentation from being overlooked, reduce mistakes, and streamline the release process (avoiding bottlenecks).
  • Direct documentation updates: To reduce mistakes and avoid having to keep a to-do list throughout the cycle.
  • External contributor PRs: The reviewers are responsible for updating the documentation (bonus: request updates from the contributor if possible).

@inancgumus inancgumus self-assigned this Feb 14, 2025
@codebien
Copy link
Contributor

➕ on my side, it would be good two split in two cases:

  • I'm a k6 maintainer
  • I'm an external contributor

@inancgumus
Copy link
Member Author

@codebien 295e9c7

@inancgumus inancgumus marked this pull request as ready for review February 18, 2025 14:30
@inancgumus inancgumus requested a review from a team as a code owner February 18, 2025 14:30
@inancgumus inancgumus requested review from mstoykov, olegbespalov, oleiade, codebien and joanlopez and removed request for a team February 18, 2025 14:30
codebien
codebien previously approved these changes Feb 18, 2025
joanlopez
joanlopez previously approved these changes Feb 18, 2025
olegbespalov
olegbespalov previously approved these changes Feb 18, 2025
Copy link
Contributor

@olegbespalov olegbespalov left a comment

Choose a reason for hiding this comment

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

Generally, LGTM, but I prefer to also include updating the labels of PR at that stage since as the release driver I'm pretty rely on them usually

@inancgumus inancgumus dismissed stale reviews from olegbespalov, joanlopez, and codebien via 8174b5d February 18, 2025 20:09
@inancgumus inancgumus force-pushed the add/doc-update-checklist-to-pr-template branch 2 times, most recently from 3a560ce to ed45bdb Compare February 18, 2025 20:13
Copy link
Contributor

@olegbespalov olegbespalov left a comment

Choose a reason for hiding this comment

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

🚀

@inancgumus inancgumus force-pushed the add/doc-update-checklist-to-pr-template branch from 9bd6d93 to 90b546b Compare February 19, 2025 14:20
@inancgumus inancgumus merged commit f2c002f into master Feb 19, 2025
28 checks passed
@inancgumus inancgumus deleted the add/doc-update-checklist-to-pr-template branch February 19, 2025 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants