Contributing

Contributing

Contributions are welcome! This section explains how to report bugs, propose features, and submit pull requests.

Reporting issues

• Provide:
  • A clear title and reproducible steps.
  • Module where issue occurred (Common / Proxy / Paper).
  • Logs (attach or paste relevant excerpts).
  • config.json files (sanitize secrets) or minimal reproduction.
• Labels: bug, enhancement, question.

Feature requests

• Create an issue describing:
  • The problem you're solving.
  • Proposed API or configuration changes.
  • Backwards compatibility considerations.

Pull Requests (PRs)

• Fork the repository.
• Create a feature branch from main.
• Add tests for new behavior.
• Keep changes focused and described in the PR body.
• Include:
  • What and why.
  • Migration steps if configs change.
  • Changelog entry (if applicable).

Coding style & tests

• Java: follow project's existing formatting (check .editorconfig or style guide).
• Tests: include unit and integration tests where applicable.

PR checklist

• Build passes locally.
• Tests added / updated.
• Documentation updated (README or wiki).
• Config samples updated if configuration changed.

Maintainers will review PRs and may request changes. Be responsive to reviews to speed up merging.

Code of Conduct

• Respectful and constructive communication expected in issues and PRs.

Special thanks to all testers and early adopters!