diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..d6d328ca4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing to 4JCraft +Thank you for considering contributing to 4JCraft! We appreciate all types of contributions, including bug fixes, new features, and documentation improvements. + +Before you start contributing, please take a moment to review the guidelines outlined here. This ensures a smooth collaboration and helps maintain the project's quality. + +## How to Contribute + +There are several ways you can contribute: + +- **Report Bugs:** If you find a bug, please open an issue to describe the problem. +- **Feature Requests:** If you have an idea for a new feature, feel free to suggest it by opening an issue. +- **Submit Code:** If you want to contribute code, fork the repository, create a new branch, and submit a pull request. + +Make sure to follow the guidelines below when submitting code or issues. + +## Submitting code + +Simple rules for publishing code: +- Do not publish AI-generated or LLM generated code +- Publish your new code in a new branch +- Join our Discord server to ping us (the lead developers) about your pull requests +- Keep your code clean and readable. +- Use conventional commits (this is not required) + +Remember ALL your changes will be licensed under GNU General Public License V3.0. diff --git a/README.md b/README.md index 1910587ed..25bc08bb8 100644 --- a/README.md +++ b/README.md @@ -6,5 +6,4 @@ 4JCraft is a modified version of the Minecraft Console Legacy Edition aimed on porting old Minecraft to different platforms (such as Linux, Android, Emscripten, etc.) -Join our community: https://discord.gg/XqPjfnWgCs - +Join our community: https://discord.gg/zFCwRWkkUg