I've already posted to mediawiki-l to try and get input from end users on these proposed changes [1], but I'd like to see if we can't change the RELEASE-NOTES format for the time that we're working on 1.23.
The main thing I've done is a bit of reordering and collection:
* New features * Breaking changes (collected in a single section) * Configuration changes * Bug fixes * API changes * Language updates * Misc changes
This is an effort to put the things users to know most about in a new release at the top of the file.
This could even be done using git comments as others have suggested.
Does this seem like a reasonable approach going forward?
Thanks for any comments,
Mark.
[1] http://article.gmane.org/gmane.org.wikimedia.mediawiki/42443
Seems like a reasonable approach to me. The old release notes were a little hard to follow, but your suggestion should make them more straightforward from now on.
Date: Thu, 7 Nov 2013 22:21:52 -0500 From: mah@nichework.com To: wikitech-l@lists.wikimedia.org Subject: [Wikitech-l] Updating the RELEASE-NOTES format for 1.22 and 1.23
I've already posted to mediawiki-l to try and get input from end users on these proposed changes [1], but I'd like to see if we can't change the RELEASE-NOTES format for the time that we're working on 1.23.
The main thing I've done is a bit of reordering and collection:
- New features
- Breaking changes (collected in a single section)
- Configuration changes
- Bug fixes
- API changes
- Language updates
- Misc changes
This is an effort to put the things users to know most about in a new release at the top of the file.
This could even be done using git comments as others have suggested.
Does this seem like a reasonable approach going forward?
Thanks for any comments,
Mark.
[1] http://article.gmane.org/gmane.org.wikimedia.mediawiki/42443
Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Le 08/11/13 04:21, Mark A. Hershberger a écrit :
The main thing I've done is a bit of reordering and collection:
- New features
- Breaking changes (collected in a single section)
- Configuration changes
- Bug fixes
- API changes
- Language updates
- Misc changes
I would put the 'breaking changes' at the top. The 'new features' tending to be very long.
wikitech-l@lists.wikimedia.org