Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (35 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 1.42 KB

Contributing to Librarr

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

Quick Start

git clone https://github.com/JeremiahM37/librarr.git
cd librarr
go build -o librarr ./cmd/librarr/
go test ./...

Good First Issues

Check the good first issue label for beginner-friendly tasks.

How to Contribute

  1. Fork the repo
  2. Create a branch (git checkout -b feature/my-feature)
  3. Make your changes
  4. Run tests (go test ./...)
  5. Commit and push
  6. Open a Pull Request

Code Style

  • Standard Go formatting (gofmt)
  • Table-driven tests with t.Run()
  • Mock HTTP calls with httptest.NewServer
  • No external test frameworks — just testing

Adding a Search Source

  1. Create internal/search/yoursource.go implementing the Source interface
  2. Add it to the source registry in internal/search/searcher.go
  3. Add config vars in internal/config/config.go
  4. Write tests in internal/search/yoursource_test.go

Areas That Need Help

  • Security audit — review HTTP clients for SSRF/injection (#4)
  • New search sources — more book/audiobook/manga sources
  • UI improvements — the web UI is functional but minimal
  • Documentation — guides for specific setups (Readarr integration, Calibre-Web, etc.)

License

By contributing, you agree that your contributions will be licensed under GPL-3.0.