Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 2.07 KB
Raw

Contributing to FactionLegends

Thank you for considering contributing to FactionLegends! We appreciate any contributions that can help improve the plugin. Please take a moment to review the following guidelines to ensure a smooth collaboration.

Issues

If you encounter any bugs, have feature requests, or want to suggest improvements, please open an issue on the GitHub repository. When submitting an issue, provide as much information as possible, including:

  • A clear description of the problem or suggestion
  • Steps to reproduce the issue
  • Relevant logs or error messages (if applicable)

Pull Requests

We welcome pull requests that address bug fixes or introduce new features. Before submitting a pull request, please ensure the following:

  1. Fork the repository and create a new branch for your changes.
  2. Follow the coding style and conventions used in the project.
  3. Write clear and concise commit messages.
  4. Include relevant test cases to validate your changes.

Development Setup

To set up the development environment for FactionLegends, follow these steps:

  1. Clone the repository to your local machine.
  2. Make your changes or additions to the codebase.
  3. Run the necessary tests to ensure that everything is functioning correctly.
  4. Submit a pull request with your changes.

Code Style

Please ensure that your code adheres to the existing coding style and conventions used in the project. This includes:

  • Using consistent indentation (preferably four spaces).
  • Following the naming conventions for variables, functions, and classes.
  • Adding appropriate comments to improve code readability.

Documentation

the documentation will be updated by the Wiki ticket in the github page

License

By contributing to FactionLegends, you agree that your contributions will be licensed under the MIT License.

We appreciate your time and effort in contributing to FactionLegends. Together, we can create an amazing plugin for the PocketMine community! If you have any further questions, feel free to reach out to the project maintainers.