7. Contributing guidelines

Contributing Guidelines

Getting Started

Requirements

• Java 21
• Git
• IDE (IntelliJ IDEA recommended)

Quick Setup

git clone https://github.com/renvins/serverpulse.git
cd serverpulse
./gradlew shadowJar

Project Structure

serverpulse/
├── api/                  # Shared interfaces
├── common/               # Common code
├── bukkit/               # Bukkit implementation
├── velocity/             # Velocity implementation
└── infra/                # Docker infrastructure

Making Changes

Branches

• Use feature/name for new features
• Use fix/name for bug fixes

Code Guidelines

• Follow existing code style
• Write clear commit messages
• Test your changes

Testing

1. Build with ./gradlew shadowJar
2. Test with both Bukkit and Velocity if applicable
3. Test with infrastructure: cd infra && docker compose up -d

Submitting Changes

1. Create pull request to master
2. Describe your changes
3. Link related issues

Need Help?

• Open an issue for questions
• Check existing documentation