Thank you for your interest in contributing to Homestead! To maintain consistency and quality, please follow these rules when contributing.
- Use 4 tabs for indentation.
- Use K&R (Kernighan & Ritchie) braces style.
- Use spaces around operators (
a = b + c, nota=b+c). - Put a space after
if,for,while, etc. (if (condition)). - Keep one blank line between methods and logical code blocks.
-
Fork & Sync
- Fork the repo and sync with the latest
mainbranch. In case there is a development branch (e.g.dev-5.1.0.0,dev-4.3.0), fork that branch instead of the main one.
- Fork the repo and sync with the latest
-
Code Quality Checks
- Ensure your code follows the style guide.
- Run tests on your Minecraft testing server.
-
Commit Messages
- Follow Conventional Commits.
- Keep commits small and logical (avoid "fixed stuff" messages).
- Provide a clear title.
- Add a detailed description:
- What changes were made?
- Why were they needed?
- Link related issues (optional).