Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Readme header upgrade.

Browse source
This commit is contained in:
pewgeuges 2021-03-08 10:10:32 +01:00
parent 6ff77dc74d
commit 0e6c5a8f87
2 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
footnotes.php
View file

@ -23,24 +23,25 @@
* @since 2.1.4
* @since 2.5.3 (Hungarian)
* @var str
* @lastmodified 2021-03-05T0457+0100
* @lastmodified 2021-03-08T1008+0100
*/
define( 'C_STR_PACKAGE_VERSION', '2.5.11d1' );
/**
* Package Version vs Stable Tag version.
* Version numbers in a WordPress plugin readme.txt header.
*
* - Adding: Documentation: Readme.txt: informative 'Package Version' field in sync with the package version currently hidden in the main PHP script header.
* - Adding: Documentation: Readme.txt: informative 'Tagged Version' field pointing a tag folder in SVN for bugfix versions available ahead of the stable tag.
* - Adding: Documentation: Readme.txt: comment line below the 'Stable Tag' field to warn that this is (unexpectedly) parsed for release configuration.
*
* @since 2.5.11
* @see readme.txt
* @link https://meta.trac.wordpress.org/ticket/5652
*
* WordPress plugin readmes are usually lacking the version number of the package.
* In Footnotes, this has been included after the stable tag had been mistaken for
* the package version, given that state-of-the-art readmes have that information.
*
* - Adding: Documentation: Readme: 'Package Version' field for information, after the 'Stable Tag' field parsed for release information.
*
* @since 2.5.11
* @see C_STR_PACKAGE_VERSION
* @see readme.txt
* @link https://meta.trac.wordpress.org/ticket/5645#comment:5
*
* - Bugfix: Codebase: revert to 2.5.8, thanks to @little-shiva @watershare @adjayabdg @staho @frav8 @voregnev @dsl225 @alexclassroom @a223123131 @codldmac bug reports.
*
* @version 2.5.10 (reversion to @version 2.5.8)

12
readme.txt
View file

@ -4,8 +4,10 @@ Tags: footnote, footnotes, bibliography, formatting, notes, Post, posts, referen
Requires at least: 3.9
Tested up to: 5.6.1
Requires PHP: 5.6
Stable Tag: 2.5.10
Package Version: 2.5.11d1
Tagged Version: 2.5.10
Stable Tag: 2.5.10
CAUTION: THE S. T. FIELD IS PARSED FOR RELEASE CONFIGURATION.
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
@ -79,11 +81,13 @@ Visit this swift write-up from a **footnotes** user by the name of **Southwest**
== Changelog ==
= 2.5.11 =
- Adding: Documentation: Readme: Header: 'Package Version' field for information, after the 'Stable Tag' field (parsed for release configuration), to prevent further misuse.
- Adding: Documentation: Readme.txt: comment line below the 'Stable Tag' field to warn that this is (unexpectedly) parsed for release configuration.
- Adding: Documentation: Readme.txt: informative 'Tagged Version' field pointing a tag folder in SVN for bugfix versions available ahead of the stable tag.
- Adding: Documentation: Readme.txt: informative 'Package Version' field in sync with the package version currently hidden in the main PHP script header.
- Bugfix: Dashboard: debug text input fields by disabling quotation mark escapement, thanks to @rumperuu code contribution during the codebase conformance overhaul.
- Update: Codebase: make all PHP code comply to WordPress Coding Standards requirements, thanks to @rumperuu code contribution and refactoring.
- Adding: Documentation: additional readme in markdown format for use with GitHub, thanks to @rumperuu code contribution.
- Adding: Documentation: help and support for contributors by the means of Contributing Guidelines, thanks to @rumperuu code contribution.
- Adding: Documentation: additional readme in markdown format 'README.md' for use with GitHub, thanks to @rumperuu code contribution.
- Adding: Documentation: help and support for contributors by the means of Contributing Guidelines 'CONTRIBUTING.md', thanks to @rumperuu code contribution.
- Adding: Development: pre-commit hook for WordPress projects, modified from @bjornjohansen, thanks to @rumperuu code contribution.
= 2.5.10 =