Skip to content
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

Document the release policy #749

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Document the release policy #749

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c81235d
Document the release policy
borine Jan 17, 2025
911c68c
Clarify use of Bug report template
borine Jan 17, 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
35 changes: 32 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If possible I would add a link to https://semver.org/ somewhere.

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

Expand All @@ -253,10 +274,18 @@ 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
[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
Expand Down
Loading