From c81235db56aa4926485aeca426061d7ad21273cc Mon Sep 17 00:00:00 2001 From: borine <32966433+borine@users.noreply.github.com> Date: Fri, 17 Jan 2025 18:58:08 +0000 Subject: [PATCH 1/4] Document the release policy --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index da9687cec..a66af1609 100644 --- a/README.md +++ b/README.md @@ -233,11 +233,32 @@ wrapper as follows: bluealsa-aplay -L ``` +## Release Policy + +The bluez-alsa project does not create nor distribute release software +packages. However, at irregular intervals, when an important new feature is +considered stable then the `master` branch is tagged with a release version +number. These tags are included only to mark reference baselines; their main +purpose is to help Linux Distribution package maintainers to relate their own +package versioning schemes to the original codebase. + +A release tag is formed as `vN.N.N` where the first number indicates a change +to the D-Bus API, the second a feature addition that does not affect the API, +and the third a significant bug-fix or internal change. A change to the D-Bus +API is generally not backwards compatible. The significant changes included in +each tag are listed in the [NEWS] file. For more detail on the changes +please consult the [commit history]. + +All changes are applied only to the `master` branch. There are no release +branches and no support for old release tags. Distributions are expected to +maintain their own patches if they need to support a package based on a release +tag without upgrading to the latest `master` branch source. + ## Contributing This project welcomes contributions of code, documentation and testing. -Please see the [CONTRIBUTING](CONTRIBUTING.md) guide for details. +Please see the [CONTRIBUTING] guide for details. ## Bug reports, feature requests, and requests for help @@ -255,8 +276,11 @@ If reporting a problem as a new issue, please use the appropriate [bluez-alsa GitHub issue reporting template][] and complete each section of the template as fully as possible. +[NEWS]: NEWS +[CONTRIBUTING]: CONTRIBUTING.md [TROUBLESHOOTING]: TROUBLESHOOTING.md [manual pages]: doc/ +[commit history]: https://github.com/arkq/bluez-alsa/commits/master/ [previous issues]: https://github.com/arkq/bluez-alsa/issues [wiki]: https://github.com/arkq/bluez-alsa/wiki [bluez-alsa GitHub issue reporting template]: https://github.com/arkq/bluez-alsa/issues/new/choose From 911c68c10fc2e6dd66d296ab1e6f91235bad894c Mon Sep 17 00:00:00 2001 From: borine <32966433+borine@users.noreply.github.com> Date: Fri, 17 Jan 2025 19:30:12 +0000 Subject: [PATCH 2/4] Clarify use of Bug report template --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a66af1609..5c61005fd 100644 --- a/README.md +++ b/README.md @@ -274,7 +274,12 @@ issue will not discover the information in there. If reporting a problem as a new issue, please use the appropriate [bluez-alsa GitHub issue reporting template][] and complete each section of -the template as fully as possible. +the template as fully as possible. Note that the `Bug report` template should +be used for all questions relating to a specific installation of BlueALSA, even +if you are not sure that it is a bug (the name of the template is set by +Github; `Problem report` would be more appropriate). In this way readers will +be given specific information about the context of the problem which will make +it easier to find a solution. [NEWS]: NEWS [CONTRIBUTING]: CONTRIBUTING.md From 4f172703a160c9bc7eda3d494e9e0248bf68ef53 Mon Sep 17 00:00:00 2001 From: borine <32966433+borine@users.noreply.github.com> Date: Sat, 18 Jan 2025 11:29:49 +0000 Subject: [PATCH 3/4] reference semver --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5c61005fd..e0523ad18 100644 --- a/README.md +++ b/README.md @@ -236,18 +236,19 @@ bluealsa-aplay -L ## Release Policy The bluez-alsa project does not create nor distribute release software -packages. However, at irregular intervals, when an important new feature is -considered stable then the `master` branch is tagged with a release version +packages. However, at irregular intervals, when an important new feature or fix +is considered stable then the `master` branch is tagged with a release version number. These tags are included only to mark reference baselines; their main -purpose is to help Linux Distribution package maintainers to relate their own +purpose is to help Linux distribution package maintainers to relate their own package versioning schemes to the original codebase. A release tag is formed as `vN.N.N` where the first number indicates a change -to the D-Bus API, the second a feature addition that does not affect the API, -and the third a significant bug-fix or internal change. A change to the D-Bus -API is generally not backwards compatible. The significant changes included in -each tag are listed in the [NEWS] file. For more detail on the changes -please consult the [commit history]. +that is **not** backwards compatible (often a change to the D-Bus API), the +second a feature addition that **is** backwards compatible, and the third a +backwards compatible bug-fix or internal change. This scheme complies with the +rules of [Semantic Versioning]. The most significant changes included in each +tag are listed in the [NEWS] file. For more detail on the changes please +consult the [commit history]. All changes are applied only to the `master` branch. There are no release branches and no support for old release tags. Distributions are expected to @@ -289,6 +290,7 @@ it easier to find a solution. [previous issues]: https://github.com/arkq/bluez-alsa/issues [wiki]: https://github.com/arkq/bluez-alsa/wiki [bluez-alsa GitHub issue reporting template]: https://github.com/arkq/bluez-alsa/issues/new/choose +[Semantic Versioning]: https://semver.org/ ## License @@ -303,3 +305,4 @@ file](LICENSE) for details. 1. [RTP Payload Format for MPEG-4](https://tools.ietf.org/html/rfc6416) 1. [Coding of MPEG-4 Audio](https://www.iso.org/standard/42739.html) 1. [ALSA project library reference](https://www.alsa-project.org/alsa-doc/alsa-lib/index.html) +1. [Semantic Versioning] From cb9e9e5d1e2c65253f996de74eb62160cf9f88ae Mon Sep 17 00:00:00 2001 From: borine <32966433+borine@users.noreply.github.com> Date: Sat, 18 Jan 2025 15:50:53 +0000 Subject: [PATCH 4/4] remove unnecessary text --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index e0523ad18..98d669136 100644 --- a/README.md +++ b/README.md @@ -277,8 +277,7 @@ If reporting a problem as a new issue, please use the appropriate [bluez-alsa GitHub issue reporting template][] and complete each section of the template as fully as possible. Note that the `Bug report` template should be used for all questions relating to a specific installation of BlueALSA, even -if you are not sure that it is a bug (the name of the template is set by -Github; `Problem report` would be more appropriate). In this way readers will +if you are not sure that it is a bug. In this way readers will be given specific information about the context of the problem which will make it easier to find a solution. @@ -305,4 +304,3 @@ file](LICENSE) for details. 1. [RTP Payload Format for MPEG-4](https://tools.ietf.org/html/rfc6416) 1. [Coding of MPEG-4 Audio](https://www.iso.org/standard/42739.html) 1. [ALSA project library reference](https://www.alsa-project.org/alsa-doc/alsa-lib/index.html) -1. [Semantic Versioning]