Add CONTRIBUTING.md to guide contributions to Backerup Releases

2026-05-22 17:20:31 +02:00
parent 3e27eb59a3
commit e4e2bfe834
1 changed files with 34 additions and 0 deletions
@@ -0,0 +1,34 @@
+# Contributing to Backerup Releases
+
+Thank you for your interest in contributing to the Backerup release artifacts repository.
+This repository is intended to store release-specific packages, release notes, and deployment artifacts.
+
+## What belongs here
+
+- Docker image archives for offline loading
+- `docker-compose.yml` or deployment manifests included with a release
+- Release notes, changelog entries, and known-issue documentation
+- Checksums, signatures, and verification metadata
+
+## How to contribute
+
+1. Open an issue if you want to suggest a new release artifact, report a problem with an existing release, or request a correction.
+2. For changes that can be handled directly, submit a pull request against the `main` branch.
+3. Ensure your PR includes a clear description of what changed and why.
+4. If you are adding or updating release notes, include the relevant version and date.
+
+## Review process
+
+- Changes are reviewed by the repository maintainers.
+- Keep contributions focused on release artifacts and documentation.
+- Non-release-related changes may be redirected to the main Backerup source repository.
+
+## Licensing and distribution
+
+This repository is governed by the terms in `LICENSE.txt`.
+By contributing, you agree that your changes are covered by the repository license.
+
+## Notes
+
+- This repository contains proprietary release artifacts for Backerup.
+- If you are looking to contribute code or feature work, please refer to the main Backerup project repository.