Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 3.55 KB

CONTRIBUTING.md

File metadata and controls

78 lines (56 loc) · 3.55 KB

Contributing to ImprovedFactions

Thank you for considering contributing to ImprovedFactions! We appreciate your interest in helping make the plugin even better. Whether it's reporting bugs, suggesting new features, improving documentation, or submitting code, we welcome contributions of all kinds.

Table of Contents

How to Contribute

There are many ways you can contribute to the project:

Bug Reports

If you find a bug in ImprovedFactions, please report it by opening an issue. When submitting a bug report, please include as much detail as possible:

  • Your Minecraft version and server version
  • Steps to reproduce the issue
  • What you expected to happen vs. what actually happened
  • Any relevant error messages or logs

Feature Requests

We’re always open to new ideas! If you have a feature request, please open an issue and tag it as a feature request. Include a description of the feature, how it would work, and why it would benefit the community.

Code Contributions

If you're interested in improving the code, feel free to submit a pull request. Follow the steps below to get started.

Development Setup

  1. Fork the Repository: Create a copy of this repository under your own GitHub account by clicking the 'Fork' button.
  2. Clone the Repository: Clone your forked repository to your local machine: 
    git clone https://github.com/your-username/ImprovedFactions_new.git
  3. Set Up Your Environment: Make sure you have a proper development environment set up, including Java, Gradle, and a Minecraft server for testing.
  4. Create a New Branch: Create a new branch to work on: 
    git checkout -b feature/your-feature-name
  5. Make Your Changes: Implement your feature or bug fix. Be sure to test thoroughly.
  6. Commit Your Changes: Commit and push your changes: 
    git add .
git commit -m "Add your feature description here"
git push origin feature/your-feature-name

Pull Request Guidelines

When you are ready to submit a pull request:

  1. Ensure Code Quality: Run tests to ensure that your changes don’t break anything. Keep code consistent with the style of the project.
  2. Write a Clear Description: Include a clear explanation of what your changes do and why they are necessary.
  3. Link Related Issues: If your pull request is related to an issue, please reference it in the description (e.g., Fixes #123).
  4. Review and Address Feedback: Be responsive to feedback provided by maintainers and community members. They might request changes or clarifications.

We aim to review pull requests as quickly as possible. Thank you for your patience.

Community Support

If you need help, feel free to:

Code of Conduct

By contributing, you agree to uphold our Code of Conduct, which helps keep our community inclusive and respectful.

We look forward to your contributions!