Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (27 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

35 lines (27 loc) · 2.06 KB
Raw

Contributing

Welcome

Do you hate your life? Do you have no friends? Do you enjoy misery?

If you answered "yes" thrice, welcome aboard! We are always looking for enthusiastic idiots contributors helping us in times of crisis, which is -- you already guessed it -- all the time!

Contribution guidelines

Small and big contributions are always welcome. Just know that we put larger or movement-related contributions under high scrutiny and are not hesitant to reject them if they do not meet our standards (which are usually quite low but in this case not). Splitting up larger contributions into smaller ones increases the chances of them being accepted, so don't be afraid to do so. If you want to contribute, but are not sure how, feel free to ask us on Discord or open an issue to discuss your idea.

4-space indentation

While we know that 4-space indentation is the standard in Java, we prefer 2-space indentation in our codebase. If you want to work with 4-space indentation, convert the file to tabs and set your tab width to 2 spaces. This way, you can work with 4-space indentation in your editor, but the codebase remains consistent with 2-space indentation.

Adding checks and sub-checks

  1. Do not create a completely new check (a class that extends the Check class) unless you consult with us beforehand.
  2. If you submit a heuristic sub-check (under ClickPatterns, Heuristics, PlacementAnalysis, etc.), describe in your PR why bypassing your check is difficult or tedious for cheat developers.

How to contribute

  1. Fork the repository and create a new branch labelled feature/your-feature-name or bugfix/your-bugfix-name.
  2. Make your changes and commit them with clear and concise messages.
  3. Push your changes to your forked repository.
  4. Open a pull request to the main repository.
  5. Wait for a maintainer to review your pull request. We may ask you to make some changes before we can merge it, so please be patient and responsive to feedback.
  6. Once your pull request is approved, it will be merged into the main branch.