[php-src] Issue #14160: Improve commit messages for upgrade notes
| From: | andrewnicols | Date: | Tue, 07 May 2024 05:03:18 +0000 |
| Subject: | [php-src] Issue #14160: Improve commit messages for upgrade notes | ||
| Groups: | php.bugs | ||
| Request: | Send a blank email to php-bugs+get-246871@lists.php.net to get a copy of this message | ||
Issue: https://github.com/php/php-src/issues/14160
Author: andrewnicols
### Description
I frequently look at the upcoming UPGRADING file to keep on top of changes which may impact our
projects.
Since this file is not ordered chronoligically, it's helpful to look at the file's history
for recent changes.
Often the commit messages are quite helpful and it's easy to identify the approximate area of
the change, but frequently they're really unhelpful, for example:
- [[ci skip] NEWS and
UPGRADING](https://github.com/php/php-src/commit/b1bb9c34e8ea7586b34dc9d75c6ca4dac3d84283)
- [NEWS/UPGRADING](https://github.com/php/php-src/commit/10ae87969e87f56149f4ebc9b16dc187da29c23f)
- [UPGRADING](https://github.com/php/php-src/commit/f68d72527aa564dfbcd30b539c76e8c696f4f5b9)
- [[ci skip]
UPGRADING](https://github.com/php/php-src/commit/a70786304bad1a6032e9ff3fdfec8f320c4e40da)
- [[ci skip]
UPGRADING](https://github.com/php/php-src/commit/6d285e3d08c5d04b339f46a315658cd8ae3f1043)
- [[ci skip]
UPGRADING](https://github.com/php/php-src/commit/6df8111a8d50ad49298169f18eb5d975408400b4)
This is just a request to either bundle the upgrading notes with the change itself, or to make the
commit message meaningful per the contribution guidelines:
> Do write your commit message in such a way that it makes sense even without the corresponding
> diff. One should be able to look at it, and immediately know what was modified. Definitely include
> the function name in the message as shown below.
https://github.com/php/php-src/blob/master/CONTRIBUTING.md#git-commit-rules
### PHP Version
N/A
### Operating System
_No response_