kernelkit / infix

Linux :yellow_heart: NETCONF = Infix
https://kernelkit.org
GNU General Public License v2.0
52 stars 12 forks source link

Checklist for code review and releases #737

Closed troglobit closed 3 weeks ago

troglobit commented 4 weeks ago

Description

After the v24.10.0 snafu (see #736) I thought it was a good idea to start a discussion about having a checklist (reminders) for maintainers:

https://github.com/kernelkit/infix/blob/checklist/.github/CHECKLIST.md

Checklist

Tick relevant boxes, this PR is-a or has-a:

jovatn commented 3 weeks ago

My two cents. Sometimes a documentation change could render a Changelog update. An example is the recent documentation fix for QoS. Thus, it may be a good idea to have a subentry checkbox for Changelog to the Documentation checkbox.

Alternatively, one could consider documentation fixes as bug fixes, but I still think there are cases where you rather wish to check documentation and changelog.

troglobit commented 3 weeks ago

My two cents. Sometimes a documentation change could render a Changelog update. An example is the recent documentation fix for QoS. Thus, it may be a good idea to have a subentry checkbox for Changelog to the Documentation checkbox.

Alternatively, one could consider documentation fixes as bug fixes, but I still think there are cases where you rather wish to check documentation and changelog.

Agreed, adding a sub-entry checkbox to the pull_request_template.md.