Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 1.72 KB
Raw

Contributing Guidelines

These are the contributing guidelines for jack-example-tools. All contributions, unless noted otherwise, are licensed under the terms of the GPL-2.0-or-later (see LICENSE). Contributions to the tools/zalsa/ are licensed under the terms of the GPL-3.0-or-later (see tools/zalsa/LICENSE).

Problems with and feature requests for the project may be reported in the issue tracker.

Changes to the code-base can be provided via pull requests.

Continuous Integration

The project is built in a continuous integration (CI) pipeline handled by github actions upon pull request and push to the default branch. The integration aims at covering all jack implementations on as many operating systems as possible.

Changes to the project may only be merged if the CI finishes successfully.

Releases

New releases are created by

  • adding a commit that
    • updates the project version in meson.build
    • updates the changelog to the current version while adding a new (empty) subsection for [Unreleased] modifications with Added, Changed and Deleted subsubsections.
  • tagging the commit using a signed tag (i.e. tag -s <VERSION>) according to the new project version

Versioning

The project's version is defined as <MAJOR> (e.g. 1 or 2), which is reflected both in the build system and the tag.

Testing

Contributors are expected to test their changes to the project on as many operating systems as available to them before opening a pull request.