Devel:ChangeLog
From PmaWiki
When contributing code it is appreciated when a line in the ChangeLog file is included. Although the file itself if mostly self explanatory a few notes below may help to keep it consistent.
The ChangeLog file is included in the top-level directory of every version. The most recent version is available in the svn webinterface
[edit] Format
Example:
- patch #0000001 [lang] Dutch update
Prefix:
- - is bugfix or change to existing code
- + is new feature
Reference to tracker item: (optional)
- bug #<number>
- patch #<number>
- rfe #<number> - Request Feature enhancement
Category:
These are specified between brackets [ ]
| short name | Full name |
|---|---|
| auth | Authentication issues |
| core | Core |
| GUI | Browser/W3C/JS compatibility |
| charset | Character Sets and Collations |
| compatibility | Compatibility |
| config | Configuration |
| export | Data Export |
| import | Data Import |
| edit | Data insertion/extraction/manipulation |
| display | Displaying results |
| doc | Documentation / How-To |
| incompatibility | Incompatibility with new MySQL releases |
| interface | Interface |
| lang | Internationalization |
| mime | MIME-transformations |
| parser | MySQL Parser |
| navi | Navigation/Usability |
| core | PHP errors |
| privileges | Privileges |
| relation | Relations,Comments,History,... |
| security | Security / Restrictions |
| prettyprint | SQL Query Pretty-Printer |
| usability | Usability |
| webserver | Webserver-related |
Description:
- In most cases identical to the summary of the tracker item.
- Please keep it short and to the point
