Contributing to BentoBox#

Thanks for wanting to help. This guide applies to all repositories in the BentoBoxWorld organization — BentoBox itself, the game modes, and the addons.

Ground rules#

• The Code of Conduct applies to all participation.
• Contributions are accepted under the project's license, EPL-2.0. Only contribute work you have the right to contribute.
• AI use is welcome — by us and by you. See the AI Policy for the details, including the rules for AI-assisted PRs, translations, and issues.

Pull requests#

PRs are always welcome — but if they are rubbish, they will be rejected, and if they need changes, changes will be asked for.

• Target the repository's development branch (usually develop), not master.
• Keep a PR to one topic. Small, reviewable PRs merge faster.
• If the repository has tests, they must pass; a fix or feature that can carry a test should carry one.
• Be ready to answer review questions and make changes. You need to be able to stand behind your contribution, at least until it is accepted.

Translations#

Only submit a translation PR if you are a native speaker of the language — see the AI Policy for why.

Bug reports and feature requests#

Open an issue on the relevant repository — for BentoBox core, that is BentoBoxWorld/BentoBox. Include what you expected, what happened, and how to reproduce it; for BentoBox core bugs, the output of /bentobox version helps a lot.

Questions and discussion#

Community discussion lives on Discord. Documentation is at docs.bentobox.world, and doc improvements are contributions too — the docs have their own repository.