HACKING

Hacking TAME
============

Copyright (C) 2012-2019 Ryan Specialty, LLC.

  Permission is granted to copy, distribute and/or modify this
  document under the terms of the GNU Free Documentation License,
  Version 1.3 or any later version published by the Free Software
  Foundation; with no Invariant Sections, no Front-Cover Texts, and no
  Back-Cover Texts.  A copy of the license is included the file
  COPYING.FDL.


This document describes conventions for developers of TAME.


Commit Messages
---------------
Tags/indicators in commit messages help to determine version number bumps.

  - Backwards-compatibility (BC) breaks must have commit subject lines
    prefixed with the string "[BC BREAK] ".

  - Feature commit subjects must be suffixed with " (feature)".

  - Bugfix commit subjects must be suffixed with " (bugfix)".


Versioning Scheme
-----------------
Use semantic versioning:

  - Backwards-incompatible changes must increment the major version number;
  - Feature additions must increment minor; and
  - Bugfixes must increment revision.

When incrementing a number, reset all that follow.