Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (58 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

85 lines (58 loc) · 2.28 KB

👋 Welcome to CodeLib!

Thanks for your interest in contributing to CodeLib – a powerful Bukkit & Velocity library by Julian Weinelt.
Whether you're fixing bugs, suggesting features, or improving docs: you're awesome. 💚

📦 Getting Started

To get started:

  1. Fork this repository
  2. Clone your fork locally: 
    git clone https://github.com/JWeinelt/codelib.git
  3. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  4. Import the project into your favorite Java IDE (IntelliJ is recommended)
  5. Make your changes, commit with clear messages: 
    git commit -m "feat: Add XYZ support to ItemBuilder"

🛠️ Build Requirements

  • Java 17+
  • Internet access to resolve dependencies from:
    • https://repo.codeblocksmc.de/releases
    • https://repo.maven.apache.org/maven2

🔍 Code Style

  • Use meaningful method and variable names.
  • Follow standard Java conventions (camelCase, spacing, etc.).
  • Keep your code readable and well-documented.
  • Use Javadoc where applicable.
  • Avoid magic numbers and hardcoded values – constants are your friends!

🧪 Testing

Please test your changes on a local server setup (e.g. with PaperMC or Velocity) before opening a PR.

Include test cases or testing instructions in your pull request description whenever possible.

🧩 Commit Conventions

Use Conventional Commits where possible:

  • feat: for new features
  • fix: for bug fixes
  • docs: for documentation only changes
  • refactor: for code changes that neither fix bugs nor add features
  • test: for adding or correcting tests

📤 Submitting a Pull Request

  • Follow the Pull Request Template
  • Open a PR against the main branch.
  • Wait for a review and be responsive to feedback – collaboration makes perfect! 💬

🧠 Need Help?

💖 Thank you

Every contribution – big or small – makes CodeLib better.
We're happy to have you aboard. Let's build something great, together. 🚀