Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 2.55 KB

Contributing to PerfectlyBalancedHorses

Thank you for considering contributing to this Spigot plugin project! Your contributions will help to make it even better.

Setting up a Workspace

  1. Clone the repository using your preferred IDE or the command line: 
    git clone https://github.com/Lyzev/PerfectlyBalancedHorses.git
  2. Open the project in your IDE and ensure that the Gradle project is imported.
  3. Run the :build Gradle task to build the project.
  4. Run the :test Gradle task to ensure that all tests pass.
  5. Make your changes and submit a pull request.
  6. Ensure that your code is formatted according to the project's code style.

How to Contribute

There are many ways to contribute to this project, from writing tutorials and implementing new features, to fixing bugs and improving the code.

Reporting Bugs

If you find a bug, please report it by creating a new issue on the project's GitHub repository. Be sure to include a clear and concise description of the issue, as well as steps to reproduce it.

Suggesting Features

If you have a great idea for a new feature, please let us know by creating a new issue on the project's GitHub repository. Be sure to include a clear and concise description of the feature, and explain why you think it would be valuable to the project.

Writing Code

If you are interested in contributing code to the project, here are a few things to keep in mind:

  • The code should be well-documented and easy to understand.
  • All code should be written in Kotlin or Java, and should be compatible with the Spigot API.
  • Before submitting a pull request, make sure that your code has been tested thoroughly and does not cause any issues with the existing code.

Style Guide

When contributing code, please follow the project's coding style and conventions. This includes:

  • JetBrains' coding conventions for Kotlin.
  • IntelliJ IDEA's default code style for Java.
  • Oracle's naming conventions for Java.

Code of Conduct

By participating in this project, you agree to follow the project's code of conduct. This includes treating all contributors with respect and refraining from any form of harassment or discrimination.

Get in Touch

If you have any questions or need help getting started, please feel free to reach out by creating an issue on the project's GitHub repository. We would be happy to help!