Skip to main content

Contributing to MediaRoulette

We love our community and welcome contributions! Whether you're a developer, a designer, or just a user with a great idea, there are many ways to help.

Bug Reports​

If you find a bug, please open an issue on our GitHub repository. When reporting a bug, please include the following information:

  • A clear and descriptive title.
  • A detailed description of the bug.
  • Steps to reproduce the bug.
  • The expected behavior and the actual behavior.
  • Your environment details (e.g., Discord client, operating system).

Feature Requests​

Have an idea for a new feature? We'd love to hear it! Please check our existing issues to see if your idea has already been suggested. If not, open a new issue with the "feature request" template.

When submitting a feature request, please include:

  • A clear and descriptive title.
  • A detailed description of the proposed feature.
  • Any potential benefits or use cases.

Pull Request Process​

If you want to contribute code, you can do so by submitting a pull request. Here's how:

  1. Fork the repository: Create a fork of the MediaRoulette repository to your own GitHub account.

  2. Create a feature branch: Create a new branch for your feature or bug fix.

    git checkout -b feature/your-amazing-feature

  3. Make your changes: Write your code and make sure to follow the project's code style.

  4. Write good commit messages: Use clear and concise commit messages that explain the purpose of your changes.

  5. Run tests: Before submitting your pull request, make sure that all tests pass.

    ./gradlew test

  6. Submit the pull request: Push your changes to your forked repository and open a pull request to the main branch of the MediaRoulette repository.

  7. Code review: Your pull request will be reviewed by one of our maintainers. They may request changes or provide feedback. Once your pull request is approved, it will be merged into the main branch.

Code Style​

We follow the standard Java code style. Please make sure your code is well-formatted and easy to read. We also use a linter to enforce code style, so make sure to run it before submitting your pull request.

Development Environment​

To set up a local development environment, you will need:

  • Java 17+
  • Gradle

For more detailed instructions, please refer to the Getting Started section of the README.

Community​

Join our Discord server to chat with other contributors and get help with your contributions.