Skip to content

Contributing

Aridro Chatterjee edited this page Nov 15, 2026 · 1 revision

Contributing to MineBridge

First of all, thanks for your interest in contributing to MineBridge!

We welcome developers who want to improve the project, fix bugs, or add new features.

How to Contribute

  1. Fork the MineBridge repository.
  2. Clone your fork.
  3. Create a new branch.
  4. Make your changes.
  5. Run the tests.
  6. Commit your changes.
  7. Push your branch.
  8. Open a Pull Request.

Development Setup

Make sure you have:

  • JDK 21
  • Git
  • Basic Java knowledge
  • Gradle

Clone your fork:

git clone https://github.com/YOUR_USERNAME/Minebridge.git
cd Minebridge

Code Guidelines

  • Keep code clean and readable.
  • Follow existing project conventions.
  • Use meaningful variable and method names.
  • Avoid unnecessary dependencies.
  • Handle exceptions properly.
  • Never commit bot tokens or private credentials.

Testing

Before submitting your changes, run:

./gradlew test
./gradlew build

Make sure the build completes successfully.

Pull Requests

When opening a Pull Request:

  • Explain what you changed.
  • Mention the issue it fixes, if applicable.
  • Include testing details.
  • Keep changes focused and easy to review.

Reporting Bugs

Found a bug?

Open an issue here:

https://github.com/aridrochatterjee/Minebridge/issues

Include relevant logs, reproduction steps, and your server environment.

Feature Suggestions

Have an idea for MineBridge?

Open a GitHub issue and describe:

  • The proposed feature
  • Why it would be useful
  • How you think it should work

Thank You!

Every contribution helps make MineBridge better.

Happy contributing!

Clone this wiki locally