Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (26 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 2.06 KB

Contributing to LightAntiCheat

LightAntiCheat is happy that you want to contribute to the project! We are always looking for new contributors to help us improve the project. We have a few guidelines that we ask you to follow when contributing to the project.

Requirements

To get started PRing changes you will need to have the following installed/condition met:

  • Java 8 JDK or later (21 is recommented because your changes have to work on EVERY version)
  • Git (obviously)
  • Hardware capable of running a Minecraft server with Paper, Spigot, Folia on different versions

Changes you are not allowed to make

  • Changes you can't "defend" like when your professor asks you what something does you should be able to explain it (We won't ask you lol)
  • Changes that are not related to the project such as adding web interfaces, anti-xray, etc.
  • Changes to code that works without any issues and doesn't need to be changed (never change a running system)

How to contribute

  1. Fork the repository
  2. Create a new branch with a descriptive name
  3. Make your changes
  4. Test your changes on every version of Minecraft that we support (Or cover most of them such as 1.8, 1.9, 1.12, 1.21)
  5. Push your changes to your fork, include [ci-skip] if your commit only contains documentation but not actual code
  6. Create a pull request
  7. Relax 😎

Tips

  • Don't be afraid to ask questions. If you have any questions about the project or how to contribute, feel free to ask in the Discord server.
  • Don't be afraid to make mistakes. If you make a mistake, we will help you fix it. We are all learning here.
  • Don't be afraid to ask for help. If you need help with something, don't be afraid to ask for help. We are all here to help each other.
  • You can set your output folder for the jars in the gradle.properties file.
  • If you don't know what to do you can take an issue to solve :D

Real men don't test in production. Test your changes before you PR them. If you don't test them we will test them and if they don't work we will close your PR.