Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMike Gerwitz <mike.gerwitz@rtspecialty.com>2018-02-01 13:07:28 -0500
committerMike Gerwitz <mike.gerwitz@rtspecialty.com>2018-02-01 13:08:03 -0500
commit088a56c336d454746df921bd29a7d2a13e45dc4c (patch)
tree1622cf904d8ec3e7144e72aebd6c0f13c5709f71
parentcac38d5e063bae251a7f6283653c2f937a5f8c47 (diff)
downloadtame-088a56c336d454746df921bd29a7d2a13e45dc4c.tar.gz
tame-088a56c336d454746df921bd29a7d2a13e45dc4c.tar.bz2
tame-088a56c336d454746df921bd29a7d2a13e45dc4c.zip
Add HACKING
* HACKING: New file. * README.md: Copyright update. Add mention of HACKING.
-rw-r--r--HACKING38
-rw-r--r--README.md6
2 files changed, 43 insertions, 1 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..1473600
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,38 @@
+Hacking TAME
+============
+
+Copyright (C) 2018 R-T Speciality, 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.
+
diff --git a/README.md b/README.md
index f5b9f62..d111cc1 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
<!---
- Copyright (C) 2015, 2016 LoVullo Associates, Inc.
+ Copyright (C) 2015, 2016 R-T Specialty, LLC.
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
@@ -51,6 +51,10 @@ pipeline as we do on our internal GitLab instance. It contains the current
state of master (with some delay), not just the most recent tag.
+## Hacking
+Information for TAME developers can be found in the file `HACKING`.
+
+
## License
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free