Skip to content

Updated issue templates for NB 25 rc phase + update PR template#8216

Merged
mbien merged 1 commit intoapache:masterfrom
mbien:update-gh-templates
Feb 13, 2025
Merged

Updated issue templates for NB 25 rc phase + update PR template#8216
mbien merged 1 commit intoapache:masterfrom
mbien:update-gh-templates

Conversation

@mbien
Copy link
Member

@mbien mbien commented Jan 31, 2025

  • added number prefixes for ordering purposes (issue templates, discussion links etc)
  • added merge/approval checklist to PR template

see below


^Add meaningful description above

Click to collapse/expand PR instructions

By opening a pull request you confirm that, unless explicitly stated otherwise, the changes -

  • are all your own work, and you have the right to contribute them.
  • are contributed solely under the terms and conditions of the Apache License 2.0 (see section 5 of the license for more information).

Please make sure (eg. git log) that all commits have a valid name and email address for you in the Author field.

If you're a first time contributor, see the Contributing guidelines for more information.

If you're a committer, please label the PR before pressing "Create pull request" so that the right test jobs can run.

PR approval and merge checklist:

  1. Was this PR correctly labeled, did the right tests run? When did they run?
  2. Is this PR squashed?
  3. Are author name / email address correct? Are co-authors correctly listed? Do the commit messages need updates?
  4. Does the PR title and description still fit after the Nth iteration? Is the description sufficient to appear in the release notes?

If this PR targets the delivery branch: don't merge. (full wiki article)

@mbien mbien added ci:no-build [ci] disable CI pipeline Release process PRs (eg. versions, sync) that are part of the release process and can be ignored in release notes. labels Jan 31, 2025
Copy link
Member

@neilcsmith-net neilcsmith-net left a comment

Choose a reason for hiding this comment

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

Generally looks good. Please check config.yml.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

will revert it back. This means the links will appear at random positions?

Copy link
Member Author

Choose a reason for hiding this comment

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

it probably will append it to the bottom. reverted

@mbien mbien force-pushed the update-gh-templates branch from ebb41fe to 9c98aab Compare January 31, 2025 14:00
@mbien
Copy link
Member Author

mbien commented Jan 31, 2025

just noticed that the checkboxes will be visible as tasks on the PR:
image

not sure if we want this

@mbien
Copy link
Member Author

mbien commented Feb 1, 2025

we could wrap it in a details section but leave it open by default?

@matthiasblaesing
Copy link
Contributor

matthiasblaesing commented Feb 1, 2025

Only the PR change part: I don't think this will help. People that actually read the text already now the part, because they already know it. At least once it was said that the bottom part of the PR should be removed and I agree with that, it should not be part of history or change log.

@mbien
Copy link
Member Author

mbien commented Feb 1, 2025

Only the PR change part: I don't think this will help

I am also not sure if this will help but I am out of ideas. The discussion on the mailing list transpired that it might help to have something what reminds devs about those things. I don't see how we can automate this, so lets give the template a try - other apache projects do have this too (example).

I had enough of having to keep linking the reviewer guide etc - it feels stupid to have to chase after committers and to have to do things like this.

At least once it was said that the bottom part of the PR should be removed and I agree with that, it should not be part of history or change log.

well. I typically remove it too on my PRs. There are also tricks to open PRs without template, so power users can get a clean slate if they want. This is intended for those who commit once per release or less - or those who keep forgetting how delivery works.

the collapsible section can be also set to auto collapse by manually removing the open from <details open>, this would add another method to de-noise the PR text as middle ground - if you don't want to remove the whole thing.

 - added number prefixes for template ordering purposes
 - added merge/approval checklist to PR template
@mbien mbien force-pushed the update-gh-templates branch from 9c98aab to ed24634 Compare February 13, 2025 01:58
@mbien mbien added this to the NB25 milestone Feb 13, 2025
@mbien
Copy link
Member Author

mbien commented Feb 13, 2025

ok lets give this a try. Experienced committers can remove the text or open PRs without a template - same as today. There is also the option to collapse the section by removing the open from <details open> as middle ground. Those who don't commit often or find the check list useful can use it as reminder.

edit: also worth mentioning that we got at least two requests for this from PMCs

@mbien mbien modified the milestones: NB25, NB26 Feb 13, 2025
@mbien mbien merged commit a60c0f8 into apache:master Feb 13, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:no-build [ci] disable CI pipeline Release process PRs (eg. versions, sync) that are part of the release process and can be ignored in release notes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants