From 1b1ef0906a73cc6047a8c335733ed946222ca8e6 Mon Sep 17 00:00:00 2001 From: Thomas Groman Date: Wed, 24 Jun 2020 20:47:27 -0700 Subject: added CONTRIBUTING and VERSIONING documentation --- CONTRIBUTING | 1 + VERSIONING | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 CONTRIBUTING create mode 100644 VERSIONING diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..cf214f0 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1 @@ +Please just send your Signed-Off patches or request-pull to tgroman@nuegia.net. If there is a need I will setup a mailing list but for right now a regular email is good enough. If you don't know how to do this please refer to the man page git-format-patch(1) and https://drewdevault.com/2019/05/24/What-is-a-fork.html diff --git a/VERSIONING b/VERSIONING new file mode 100644 index 0000000..da8926a --- /dev/null +++ b/VERSIONING @@ -0,0 +1,16 @@ +This software uses Semantic Versioning. + +Given a version number MAJOR.MINOR.PATCH, increment the: + +1. MAJOR version when you make incompatible API changes, +2. MINOR version when you add functionality in a backwards compatible manner, and +3. PATCH version when you make backwards compatible bug fixes. + +In addition this software uses labels such as RELEASE CANDIDATE for when I think things +good enough for a STABLE RELEASE but needs further real world testing. RELEASE +versions are tagged with Git so that you may checkout and build specific releases. + +Non-tagged versions are essentially developer nightly versions and NOT intended for +general usage. + +see https://semver.org/ for the specifics -- cgit v1.2.3