Home

Philosophy

The philosophy of this framework is to avoid altering the existing code of Minecraft. The design aims to keep the original code intact while providing an extensible and flexible system for managing Graphical User Interfaces (GUIs).

How to Contribute

Set Up Your Development Environment:

Fork the repository on GitHub. Clone your fork to your local machine using git clone . Follow the setup instructions in the README to configure your environment.

Report Bugs:

If you encounter a bug, please check if it has already been reported by searching the issues on GitHub. Create a new issue with a clear description of the bug, steps to reproduce, and any relevant logs or screenshots.

Propose Changes or Features:

Before proposing significant changes, discuss your idea with the maintainers by creating an issue or starting a discussion. For structure changes or enhancements, provide a detailed explanation of the change and how it improves the framework. Submit a pull request with your proposed changes. Make sure to include a description of the changes and why they are necessary.

Follow Coding Standards:

Adhere to the coding style and standards outlined in the repository’s CONTRIBUTING.md (if available) or existing code. Ensure your code is well-documented and includes comments where necessary.

Testing:

Write tests for any new features or bug fixes you implement. Ensure all existing tests pass before submitting your pull request. If your changes affect the GUI, manually test the interface to ensure it functions as expected.

Review Process:

Once your pull request is submitted, the maintainers will review your code. Be open to feedback and make any necessary adjustments. Address any review comments and make revisions as needed.

Respect the Project's Philosophy:

Ensure your contributions align with the project's philosophy of avoiding alterations to the existing Minecraft code.