Skip to main content

Contributing

Setup​

Requires Java 17+, Maven 3.6+, Git.

git clone https://github.com/yourusername/SigmaTools.git
cd SigmaTools
git remote add upstream https://github.com/sigmatools/SigmaTools.git
mvn clean package

Test by copying the built JAR to a test server.

Coding Standards​

  • Follow Java naming conventions, 4-space indentation
  • Javadoc on public methods
  • Keep classes single-responsibility; use managers for feature-specific logic; follow existing patterns
/**
 * Manages tool cooldown system
 */
public class CooldownManager {
    /**
     * @param player The player
     * @param toolType The tool type
     * @return true if player can use tool
     */
    public boolean canUseTool(Player player, ToolType toolType) {
        // Implementation
    }
}

Branch Naming​

feature/..., fix/..., docs/..., refactor/...

Pull Requests​

  1. git checkout -b feature/your-feature
  2. Make changes, update docs, add tests if applicable
  3. Commit with a descriptive message (e.g. "Fix economy deduction not working with CoinsEngine", not "fix")
  4. Push and open a PR against sigmatools/SigmaTools

PR description should cover What, Why, How, and Testing steps. Checklist before submitting: style followed, changes tested, docs updated, no undocumented breaking changes, clean commits.

Getting Help​

  • Discord: Join
  • GitHub Issues for bugs/questions

By contributing, you agree your contributions are licensed under the project's license.

See Also​