|
| 1 | +# Contributing to ReShaped |
| 2 | + |
| 3 | +Thank you for considering contributing to ReShaped. Contributions are welcome and appreciated. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +1. Fork this repository on GitHub |
| 8 | +2. Clone your fork: |
| 9 | +```bash |
| 10 | + git clone https://github.com/F-3-R-R-3/reshaped-1.20.1.git |
| 11 | +``` |
| 12 | +4. Enter the project folder: |
| 13 | +``` |
| 14 | + cd reshaped-1.20.1 |
| 15 | +``` |
| 16 | +6. Create a new branch: |
| 17 | +``` |
| 18 | + git checkout -b feature/your-change |
| 19 | +``` |
| 20 | +> [!TIP] |
| 21 | +> Or alternatively, you can use the bultin Git functionallity of IDE's like Intellij (<- reccomended) or VSCode to clone this repo locally and create a branch. |
| 22 | +> You can always ask me for help setting up a coding environment and git branch by creating a Github issue! |
| 23 | +
|
| 24 | +## Development Setup |
| 25 | + |
| 26 | +This project is a Fabric mod for Minecraft 1.20.1. |
| 27 | + |
| 28 | +Requirements: |
| 29 | +- Java 17 or higher |
| 30 | +- Gradle (wrapper included) |
| 31 | + |
| 32 | +Run the client in development mode: |
| 33 | +./gradlew runClient |
| 34 | + |
| 35 | +Build the mod: |
| 36 | +./gradlew build |
| 37 | + |
| 38 | +The output jar will be located in: |
| 39 | +build/libs |
| 40 | + |
| 41 | +## Code Guidelines |
| 42 | + |
| 43 | +- Keep code clean and readable |
| 44 | +- Follow existing project structure |
| 45 | +- Use clear naming for classes and methods |
| 46 | +- Avoid large unrelated changes in one pull request |
| 47 | + |
| 48 | +## What You Can Contribute |
| 49 | + |
| 50 | +- Bug fixes |
| 51 | +- Performance improvements |
| 52 | +- New block or shape logic |
| 53 | +- Compatibility fixes with other mods |
| 54 | +- UI or usability improvements |
| 55 | +- Refactoring and cleanup |
| 56 | + |
| 57 | +## Issues |
| 58 | + |
| 59 | +Before opening an issue: |
| 60 | +- Check if it already exists |
| 61 | +- Include Minecraft version and mod version |
| 62 | +- Add logs or screenshots if possible |
| 63 | +- Provide steps to reproduce the problem |
| 64 | + |
| 65 | +## Pull Requests |
| 66 | + |
| 67 | +When submitting a pull request: |
| 68 | +- Clearly describe what changed |
| 69 | +- Keep changes focused |
| 70 | +- Ensure the mod still runs and builds |
| 71 | +- Test in-game before submitting |
| 72 | + |
| 73 | +## Important Systems |
| 74 | + |
| 75 | +Be careful when modifying: |
| 76 | +- Block associations |
| 77 | +- Block registration |
| 78 | + |
| 79 | +These parts affect global mod behavior. |
| 80 | + |
| 81 | +## AI Usage |
| 82 | + |
| 83 | +AI-generated code is allowed. |
| 84 | + |
| 85 | +Please review, test, and understand any AI-generated code before submitting it. Contributions are judged by their quality and maintainability, not by whether AI was used. |
| 86 | + |
| 87 | +I use AI tools myself, but I try to keep their use to a minimum whenever possible. |
| 88 | + |
| 89 | +## License |
| 90 | + |
| 91 | +By contributing, you agree that your code will be licensed under the same license as the project (LGPL-3.0). |
0 commit comments