Thank you for taking your time to contribute 💖
Check Table of Contents to see how you can contribute!
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
1. Pick an issue
Pick an issue you are interested in dealing with.
2. Notify that you are working on that issue
If you don't let others know you are working on it then someone else could also pick that one.
3. Make your changes
Make sure you're following the style guide.
4. Open a pull request
Don't forget to mention the issue!
5. Wait for the pull request to be reviewed
Should take from anywhere between 10 minutes to 2 weeks
One way to contribute to Kontraption is by improving the project's wiki. The wiki serves as a central hub for documentation, tutorials, and other helpful resources for players. Here are some ways you can improve the wiki:
-
Fix typos and errors: If you come across a typo or error in the wiki, feel free to fix it! Simply click the "Edit" button on the relevant page and make your changes. Be sure to note all the additions and removals in the edit message when making changes.
-
Add missing information: If you notice that a page is missing important information, consider adding it yourself. This could include additional examples, explanations, or links to related resources.
Kontraption uses gitmoji for commits, please make sure you follow the gitmoji guide when writing the commit message.
Examples:
📝 added modrinth link to the README
⚖️ tweaked fuel consumption math
✨🐛 added oil drill, fixed #12