Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (67 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

99 lines (67 loc) · 2.69 KB
Raw

Contributing to AetherAC

First off, thank you for considering contributing to AetherAC. It's people like you that make AetherAC a great anti-cheat.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to contact@abnt.it.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue tracker to see if the problem has already been reported. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title for the issue
  • Describe the exact steps to reproduce the problem
  • Describe the behavior you observed and what you expected to see
  • Include server logs if applicable
  • Include your server platform (Paper/Purpur/Folia/etc.) and version
  • Include your AetherAC version

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Explain why this enhancement would be useful to other users
  • Include any relevant examples or mockups if applicable

Pull Requests

Closed Source — Not Accepting Pull Requests.

Development Setup

Prerequisites

  • Java 25 (for modern versions) or Java 8 (for legacy)
  • Gradle (wrapper provided)

Building

./gradlew build

Running Tests

./gradlew test

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Java/Kotlin Style

  • Follow the Google Java Style Guide
  • Use 4 spaces for indentation
  • Use meaningful variable names
  • Document public APIs with Javadoc

Additional Notes

Issue and Pull Request Labels

Label Purpose
bug Something isn't working
enhancement New feature or request
documentation Documentation improvements
help wanted Extra attention is needed
good first issue Good for newcomers
research Needs investigation

Recognition

Contributors will be recognized in our README and release notes.

Questions?

If you have any questions, feel free to reach out at contact@abnt.it or open a discussion.

Thank you for contributing to AetherAC!