Version Rules

  • Format X.Y.Z

  • X - major. never change it

  • Y - minor. increment when introducing new features

  • Z - patch. increment it for all other changes

If incrementing version

  • Update X.Y.Z in README.md: Changelog

  • Update PROJECT_VERSION in root CMakeLists.txt

  • Update changes in CHANGELOG.md

Commit description

  • Prepare description according to template below. Skip sections if empty or not applicable.

  • Title format: Either [] or [test] , [build] , [refactoring] . Example: [0.3.1] Recent files and workspaces features

  • Requirements for commit description can be found in ‘req/requirements.pu’

===== BEGIN EXAMPLE ===== Title: [x.y.z | test | build | refactoring] </p> <p>New</p> <ul class="simple"> <li><p>[<requirement ID>] <description> …</p></li> </ul> <p>Fixed</p> <ul> <li><change> </li> <li><change> </li> </ul> <other changes> ===== END EXAMPLE ===== </div> </div> <footer> <hr/> <div role="contentinfo"> <p>© Copyright 2021, Igor Krechetov.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>