16 feature publish library to arduino (#28)

Author: totally-not-frito-lays

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md renamed to .github/pull_request_template.md

@@ -11,7 +11,7 @@ assignees: '@totally-not-frito-lays'
 
 Closes the following issues (all PRs must close an issue):
 
--
+- closes `REPLACEME WITH ISSUE #`
 
 **What's being changed**
 
@@ -26,4 +26,6 @@ Closes the following issues (all PRs must close an issue):
 **Check off the following**
 
 - [ ] I have tested my changes locally
-- [ ] I have assigned a codeowner as a reviewer (default is @totally-not-frito-lays)
+- [ ] I have incremented the version number in the [library.properties](/library.properties) file [^1]
+
+[^1]: See [CONTRIBUTING.md](/CONTRIBUTING.md) for more information on version semantics

CONTRIBUTING.md

@@ -47,6 +47,29 @@ Each feature has an overarching branch that is prefixed with `<issue number>-fea
 ![Branching Strategy](./docs/assets/branching.png)
 [Branching Strategy](https://excalidraw.com/#json=a5Nm80xPT2uzbYwdAoNp4,Yggmz2D6xa9LTu0WR1loQw)
 
+## Git Versioning Semantics
+
+Git Version Tags / Release Tags are required to be accepted into the Arduino Registry. The current version should be reflected in [library.properties](/library.properties)
+
+Each new PR should increment the current release version in the following format `version.feature.patch`:
+- `1.0.0` for full new versions that has major rewrites in the corresponding instruction material
+- `0.1.0` for new features or activities
+- `0.0.1` for bug patches or fixes
+
+When the release version is incremented, any numbers to the right are reset to 0.
+
+- Ex: New major version: `0.2.0` -> `1.0.0`
+  - Version `0 -> 1`
+  - Feature `2 -> 0`
+  - Patch `0 -> 0`
+- Ex: New feature: `4.8.2` ->  `4.9.0`
+  - Version `4`
+  - Feature `8 -> 9`
+  - Patch `2 -> 0`
+- Ex: New patch: `5.4.22` -> `5.4.23`
+  - Version `5`
+  - Feature `4`
+  - Patch `22 -> 23`
 
 ## FAQ
 

library.properties

@@ -1,5 +1,5 @@
 name=CC-Lantern
-version=0.2.0
+version=1.0.0
 author=Code With Her
 maintainer=Ryan <[email protected]>
 sentence=Arduino library for controlling single-wire-based LED pixels and strip.