Skip to content

Add Note About Versioning to Readme #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CBielstein merged 2 commits into from
Oct 5, 2025
Merged

Add Note About Versioning to Readme #182

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ae42d7
Add note about versioning to readme.
CBielstein Oct 5, 2025
1da949a
Fixes for the linter.
CBielstein Oct 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,24 @@ 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:
Expand Down