4jcraft/CONTRIBUTING.md
2026-03-06 18:37:31 +00:00

1.3 KiB

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) Make sure your code compiles before making a pull request! and make sure that it's readable

Remember ALL your changes will be licensed under GNU General Public License V3.0.