[incubator-plc4x] branch develop updated: - Added some more documentation on things we noticed when preparing the last release branch

[cd...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git


The following commit(s) were added to refs/heads/develop by this push:
     new aebdb7e  - Added some more documentation on things we noticed when preparing the last release branch
aebdb7e is described below

commit aebdb7e601231cfe4c576d51eb82b2e6ad89a9b4
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Thu Jan 17 09:31:27 2019 +0100

    - Added some more documentation on things we noticed when preparing the last release branch
---
 src/site/asciidoc/developers/release.adoc | 37 +++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/src/site/asciidoc/developers/release.adoc b/src/site/asciidoc/developers/release.adoc
index 7f3b882..ce21cf1 100644
--- a/src/site/asciidoc/developers/release.adoc
+++ b/src/site/asciidoc/developers/release.adoc
@@ -75,6 +75,15 @@ If you happen to have multiple keys, adding the following profile to your `setti
       </properties>
     </profile>
 
+=== Preparing the codebase for a release
+
+Usually you will have to update the RELEASE_NOTES document to the new version.
+I would suggest doing this prior to the branch as otherwise you will definitely have to port it back to `develop`.
+So remove the `SNAPSHOT` and `(Unreleased)` markers from the file and add missing parts.
+
+Also if you are doing the first release in a new year, it is advisable to search for the old year and check if any occurrences are ok the way they are.
+Usually the `NOTICE` file has to be adjusted.
+
 === Creating a release branch
 
 According to SemVer, we have: Major, Minor and Bugfix releases.
@@ -110,6 +119,34 @@ This step now should perform quite quickly as no build and no tests are involved
 
 However in the end the versions of the `develop` branch are updated and a new `rel/0.2` branch is created.
 
+=== Preparing `develop` for the next iteration
+
+Now is a good time to add a new section to the `RELEASE_NOTES` document for the new `SNAPSHOT` version.
+
+Here comes a template:
+
+```
+==============================================================
+(Unreleased) Apache PLC4X (incubating) 0.X.0-SNAPSHOT
+==============================================================
+
+New Features
+------------
+
+Incompatible changes
+--------------------
+
+Bug Fixes
+---------
+
+// Rest of the file
+
+```
+
+Also be sure to do a quick full-text-search to check if the version was updated correctly everywhere.
+
+WARNING: If you find anything here, you will need to pay attention during the release.
+
 === Release stabilization phase
 
 Now usually comes a phase in which last tests and checks should be perfomed.