Development & Contribution

Information on building mkbrr from source, running tests, and contributing.

Prerequisites

Before you begin, ensure you have the following installed on your system:

1. Install Go

   Install Go version 1.23.4 or higher

   macOS

   brew install go
   

   Verify installation:

   go version
   

2. Install Git

   Required for version control and building from source

   macOS

   brew install git
   

3. Install Make

   Required for running build commands

   macOS

   # Included with Xcode Command Line Tools
   xcode-select --install
   

For other package managers or installation methods, please refer to the official documentation:

• Go Installation Guide
• Git Installation Guide
• Make Installation Guide

Building from Source

1. Clone Repository

   git clone https://github.com/autobrr/mkbrr.git
   

2. Change Directory

   cd mkbrr
   

3. Build Binary

   make build
   

The binary will be created in the build/ directory with version information from git tags

Development Commands

Common Commands Reference

Build Commands

make build          # Build the binary
make clean          # Remove build artifacts
make all            # Clean, build, and install the binary
make install        # Install the binary in GOPATH

Testing Commands

make test             # Run tests (excluding large tests)
make test-race        # Run all tests with race detector
make test-race-short  # Run quick tests with race detector
make test-large       # Run large tests (resource intensive)
make test-coverage    # Run tests with coverage report

Quality Tools

make lint             # Run golangci-lint

Run make help to see all available commands and their descriptions

Contributing

Thanks for taking interest in contributing! We welcome anyone who wants to contribute. If you have an idea for a bigger feature or a change, please discuss it first by opening an issue or joining our Discord.

You can contribute to either:

• Main repository - Core functionality and features
• Documentation repository - Documentation improvements

1. Ways to Contribute

   • New features and improvements
   • Bug fixes and reports
   • Documentation updates
   • Community support
2. Getting Started

   1. Fork the mkbrr repository
   2. Clone your fork: git clone github.com/YOURNAME/mkbrr
   3. Create a feature branch: git checkout -b feat/your-feature
   4. Make your changes following our guidelines
3. Submit Changes

   • Reference related issues
   • Mark as Draft if work in progress
   • Keep changes focused and atomic
   • Be responsive to review feedback

Development Guidelines

Commit Guidelines

We follow Conventional Commit Guidelines:

• feat(core): add new torrent validation
• fix(filter): correct pattern matching
• docs(api): update endpoint documentation

No need for force pushing or rebasing - we squash commits on merge.

Code Style

• Try to follow Go best practices and idioms
• Use meaningful variable and function names
• Add comments for complex logic
• Keep functions focused and concise
• Run go fmt or gofumpt before committing

License

mkbrr is licensed under the GNU General Public License v2.0. See the LICENSE file for full details.