FormZ is using a similar way as TYPO3 for documenting its changes. The official guide on how to contribute can be found here:
Some rules differ though:
- The folder
masteris replaced by
- No forge issue number can be used, so the filename convention is set to
- Tagging changes is not mandatory.
- The folder containing a version and its changes must be prefixed by
For a new release, the steps below must be followed:
- The folder
Releaseshould be duplicated to a new folder named after the new version number (prefixed by a
- Every changelog file in
Development/Changesmust be moved into the
Changessub-folder of the newly created folder;
- The files
Release.txtmust be updated with correct information about the new release;
- The file
Notes.rstshould contain general information about the new release.
You can find the current development branch changelog here: Branch “development”.
For the release of the version
|── Development | |── Index.rst | |── Changes | |── Feature-SomeFeature.rst | |── Deprecation-SomeDeprecationChange.rst |── Release | |── Index.rst | |── Notes.rst | |── Release.txt
|── Development | |── Index.rst |── v1.42.0 | |── Index.rst | |── Notes.rst | |── Release.txt | |── Changes | |── Feature-SomeFeature.rst | |── Deprecation-SomeDeprecationChange.rst