Add HACKING

* HACKING: New file.
* README.md: Copyright update.  Add mention of HACKING.
master
Mike Gerwitz 2018-02-01 13:07:28 -05:00
parent cac38d5e06
commit 088a56c336
2 changed files with 43 additions and 1 deletions

38
HACKING 100644
View File

@ -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.

View File

@ -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