Contributing¶

Thank you for your interest in contributing to SigmaTools! This guide will help you get started.

Development Setup¶

Prerequisites¶

• Java 17 or higher
• Maven 3.6+
• IDE (IntelliJ IDEA recommended)
• Git

Getting Started¶

1. Fork the Repository

2. Fork SigmaTools on GitHub

3. Clone Your Fork

   git clone https://github.com/yourusername/SigmaTools.git
   cd SigmaTools
   

4. Set Up Remote

   git remote add upstream https://github.com/sigmatools/SigmaTools.git
   

5. Build the Project

   mvn clean package
   

6. Test Locally

7. Copy JAR to test server
8. Test your changes

Coding Standards¶

Java Style¶

• Follow Java naming conventions
• Use meaningful variable and method names
• Add Javadoc comments for public methods
• Keep methods focused and small
• Use proper indentation (4 spaces)

Code Structure¶

• Keep classes focused on single responsibility
• Use managers for feature-specific logic
• Follow existing code patterns
• Maintain consistency with existing code

Example¶

/**
 * Manages tool cooldown system
 */
public class CooldownManager {

    /**
     * Check if player can use tool
     * 
     * @param player The player
     * @param toolType The tool type
     * @return true if player can use tool
     */
    public boolean canUseTool(Player player, ToolType toolType) {
        // Implementation
    }
}

Making Changes¶

Branch Naming¶

Use descriptive branch names: - feature/tool-name - New features - fix/issue-description - Bug fixes - docs/documentation-update - Documentation - refactor/component-name - Code refactoring

Commit Messages¶

Write clear, descriptive commit messages:

Good:
- "Add support for custom tool materials"
- "Fix economy deduction not working with CoinsEngine"
- "Improve performance of block scanning"

Bad:
- "fix"
- "update"
- "changes"

Pull Request Process¶

1. Create Feature Branch

   git checkout -b feature/your-feature
   

2. Make Changes

3. Write code
4. Add tests if applicable

5. Update documentation

6. Commit Changes

   git add .
   git commit -m "Descriptive commit message"
   

7. Push to Your Fork

   git push origin feature/your-feature
   

8. Create Pull Request

9. Go to GitHub
10. Click "New Pull Request"
11. Select your branch
12. Fill out PR template
13. Submit for review

Pull Request Guidelines¶

Before Submitting¶

• Code follows style guidelines
• Changes are tested
• Documentation is updated
• No breaking changes (or documented)
• Commits are clean and descriptive

PR Description¶

Include: - What - What changes were made - Why - Why these changes are needed - How - How the changes work - Testing - How to test the changes

Example PR Description¶

## What
Adds support for custom tool materials in configuration.

## Why
Allows server admins to customize tool appearance without code changes.

## How
- Reads `item-material` from config
- Validates material exists
- Uses material when creating tools

## Testing
1. Set `tools.pickaxe.item-material: GOLDEN_PICKAXE` in config
2. Give tool: `/sigmatools give pickaxe PlayerName`
3. Verify tool is golden pickaxe

Areas for Contribution¶

Code Contributions¶

• Bug Fixes - Fix reported issues
• New Features - Add requested features
• Performance - Optimize existing code
• Refactoring - Improve code quality

Documentation¶

• Documentation Updates - Improve existing docs
• Examples - Add code examples
• Tutorials - Write guides
• Translations - Translate messages

Testing¶

• Test Cases - Add unit tests
• Integration Tests - Test with other plugins
• Bug Reports - Report issues with details

Code Review Process¶

1. Automated Checks
2. Code compiles
3. No obvious errors

4. Follows style guidelines

5. Maintainer Review

6. Code quality
7. Functionality
8. Documentation

9. Testing

10. Feedback

11. Address review comments
12. Make requested changes

13. Resolve discussions

14. Approval

15. Maintainer approves
16. Changes merged

Getting Help¶

Questions?¶

• Discord: Join Discord
• GitHub Issues: Create an issue
• Documentation: Check the docs

Stuck?¶

• Ask for help in Discord
• Create a draft PR for feedback
• Check existing issues/PRs

License¶

By contributing, you agree that your contributions will be licensed under the same license as the project.

Thank You!¶

Thank you for contributing to SigmaTools! Every contribution, no matter how small, is appreciated.