Skip to content

Getting started

The Homebox project welcomes contributions from developers of all skill levels. Whether you’re a seasoned open-source contributor or new to the world of collaborative software development, our guides will help you get started.

We welcome contributions of all kinds, including documentation, bug reports, feature requests, code, translations, or even just monetary support.

We highly recommend reading the Code of Conduct before contributing. We expect all contributors to abide by it. Failure to do so may result in a permanent ban from the project. We will not tolerate any form of harassment or discrimination.

To contribute code, please read our development guide. We’ve made significant effort to make the process as easy as possible. Not only do we have the documentation for the dependencies, tooling, etc. that you’ll need, but we’ve also made heavy documentation of internal architecture designs and design decisions that you can use as a reference.

We welcome contributions to our translations! If you’re interested in helping translate Homebox into other languages, please read our translation guide. We accept translations for our documentation and user-facing strings.

We welcome contributions to our documentation! If you’re interested in helping improve our documentation, you can get started by reading our documentation guide. We use Starlight to generate our documentation, so you’ll need a basic understanding of Markdown and Starlight syntax.

If you’ve found a bug in Homebox, please report it by opening an issue on our GitHub repository.

We accept feature requests through our GitHub repository discussions board.

We also welcome contributions in other ways, such as sponsoring our development efforts or helping us promote Homebox.