From 2ae42d7a2cb6fc13e354a70a4a42e00bada0ed6c Mon Sep 17 00:00:00 2001 From: Cameron Bielstein Date: Sat, 4 Oct 2025 23:05:06 -0700 Subject: [PATCH 1/2] Add note about versioning to readme. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index c8e88a6..f8dc75c 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,22 @@ visualizing APRS digital packets in a straight-forward manner. This project is provided as [open source](LICENSE) and developed by the community for the community. +## Note on Versioning + +Currently, all packages from this repo change version together. +Although that isn't fully ideal, it is easy and works for now. + +The goal is for v1.0.0 to come when the APRS v1 spec is implemented, then increment up from there. + +Until then, this packages from this repo use a slightly modified [semver](https://semver.org/). +For version x.y.z: + +* x stays 0 for pre-release (again, until the APRSv1 spec is implemented). +* y updates for any breaking changes (and there may be breaking changes during pre-release development). +* z updates with new non-breaking functionality, bug fixes, or other changes. + +This is essentially semver shifted to the right. + ### Further Documentation See supplemental documentation for APRS# constituent projects: From 1da949a4f32df00ae2b24bbaeb0536ad166124ce Mon Sep 17 00:00:00 2001 From: Cameron Bielstein Date: Sat, 4 Oct 2025 23:08:53 -0700 Subject: [PATCH 2/2] Fixes for the linter. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f8dc75c..92b7fed 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,15 @@ community for the community. Currently, all packages from this repo change version together. Although that isn't fully ideal, it is easy and works for now. -The goal is for v1.0.0 to come when the APRS v1 spec is implemented, then increment up from there. +The goal is for v1.0.0 to come when the APRS v1 spec is implemented, then +increment up from there. Until then, this packages from this repo use a slightly modified [semver](https://semver.org/). For version x.y.z: * x stays 0 for pre-release (again, until the APRSv1 spec is implemented). -* y updates for any breaking changes (and there may be breaking changes during pre-release development). +* y updates for any breaking changes (and there may be breaking changes during +pre-release development). * z updates with new non-breaking functionality, bug fixes, or other changes. This is essentially semver shifted to the right.