Contributing to PurgeBot

Thank you for taking the time to contribute! Here's how to get involved.

Reporting bugs

Join the support server and report the bug there. Include steps to reproduce, what you expected, and what actually happened.

Suggesting features

Join the support server and share your idea. Describe the use case clearly — the more context, the better.

Contributing code

1. Fork the relevant repository and create a branch from main.
2. Follow the existing code style — run go fmt ./... before committing.
3. Keep changes focused. One concern per PR.
4. Make sure no replace directives in go.mod are left uncommented.
5. Open a pull request against main and fill in the PR template.

All pull requests require review from @PurgeBot-net/devs before merging.

Development setup

Each service is a standalone Go module. See the README.md in the relevant service directory for its specific configuration.

For local development across services, uncomment the replace directives in the service's go.mod to point at your local copies of common, database, and locale:

replace github.com/PurgeBot-net/common => ../common
replace github.com/PurgeBot-net/database => ../database
replace github.com/PurgeBot-net/locale => ../locale

Remember to comment these out again before opening a PR.

Questions?

Join the support server and ask in the relevant channel.