Skip to content

Latest commit

 

History

History
55 lines (48 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

55 lines (48 loc) · 3.95 KB
Raw

Contributing Guidelines

Thank you for considering to contribute! Here are some guidelines to help you get started.

Pull Requests

1. Keep Pull Requests Small and Focused

  • 1 PR = 1 change: Each pull request should address a single issue or add a single feature.
  • Avoid Bloat: Aim to keep the diff small and digestible. Don't stuff PRs with unrelated changes.

2. Respect the Project's Scope and Vision

  • Communicate Before Coding: Open an issue to discuss any major changes before you start working on them. This can save you a lot of time and effort in case your idea is rejected. When in doubt, ask first.
  • Avoid Breaking Changes: When modifying existing features, it's usually better to make your changes optional. Your version may work better for you, but other people will often have different use cases that rely on the original behavior.

3. Ensure Quality and Completeness

  • Finish the Code: Submit a PR only when it's complete, tested, and ready for review. Don't use pull requests as a dumping ground for half-baked prototypes.
  • If you need early feedback on a larger change, clearly mark the PR as a draft. You should have already started a discussion and gotten the go-ahead for your idea at this point.
  • Watch the Checks: Make sure that all automated checks are passing and that there aren't any merge conflicts. Fix such issues before asking for a review.

4. Follow the Code Style

  • Run Eclipse's Clean Up and Format tools with the settings from the codestyle folder.
  • If you don't use Eclipse, you can run ./gradlew spotlessApply instead. However, be aware that this isn't as thorough as Eclipse's tools.
  • For anything that these automated tools don't cover, please try to match the existing code style as closely as possible.

Other Ways To Help

  • fixing a typo
    • in the Wurst Client itself (look for the pen icon at the top right)
    • on WurstClient.net (scroll all the way down and click "edit this page")
    • on the Wurst Wiki (login and click "Edit this page")
  • improving an existing bug report
    • figuring out which Minecraft versions are affected by the bug
    • Can you figure out how to make the bug happen every time? If so, please let me know.
  • reporting a new dupe/exploit in Minecraft that could be added to Wurst
  • helping with a feature request
    • Can you explain how the feature works?
    • Can you add the feature in a Pull Request?
    • Do you know anything else about the feature that hasn't been mentioned?
  • helping with the Wurst Wiki
    • translating Wurst Wiki articles to another language
    • adding screenshots of features where appropriate
    • making sure that changes from recent Wurst updates are documented
    • digging through old Wurst updates to find out when exactly a feature was added
  • helping people who can't figure out how to install Wurst
  • making tutorials / how-to videos
  • creating more backups/archives of Wurst
  • just spreading the word, telling people about Wurst, etc.
  • expanding this list with more things that people can do to help (This is all I could think of for now.)