Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.6 KB
Raw

Contributing to Borg Backup Server

Thanks for your interest in contributing! Here's how to get started.

Reporting Bugs

  • Use the Bug Report issue template
  • Include your BBS version, installation type (Docker or bare metal), and steps to reproduce
  • Paste relevant log output if available

Suggesting Features

  • Use the Feature Request issue template
  • Describe the use case and why it would be useful

Pull Requests

  1. Fork the repository and create a branch from main
  2. Make your changes — keep them focused on a single issue or feature
  3. Test on both Docker and bare metal installs if possible
  4. Submit a PR against main with a clear description of what changed and why

Guidelines

  • PHP 8.1+ — no framework, vanilla PHP with Bootstrap 5 frontend
  • MySQL syntax — this project uses MySQL/MariaDB, not SQLite
  • No direct sudo in PHP — all privileged operations go through bin/bbs-ssh-helper
  • Agent changes — logic must live in bbs-agent.py (the .py file served from the server), never in the launcher exe. The exe cannot be auto-updated.

Development Setup

Docker (quickest):

docker compose up -d

Bare metal:

  • Ubuntu 22.04+ with Apache, PHP 8.1+, MariaDB/MySQL 8.0
  • Run bin/bbs-install for initial setup

Security Vulnerabilities

Please do not open public issues for security vulnerabilities. See SECURITY.md for responsible disclosure instructions.