-
Notifications
You must be signed in to change notification settings - Fork 29
Contributing to Growthcraft
Welcome, eventually this document will contain all that you need to contribute to Growthcraft.
##Setting Up Your Environment
Clone and initialise current development branch
git clone https://github.com/GrowthcraftCE/Growthcraft-1.7.git
cd Growthcraft-1.7
git submodule init
git submodule update
Let Gradle download and set up Forge and other dependencies
./gradlew setupDecompWorkspace
Setup IDE as Eclipse
./gradlew eclipse
Or IntelliJ
./gradlew ideaModule
###Download Forge
Go to the Forge website and download Forge 1448 for contributing to Growthcraft 2.
###Setup forge
Extract the Forge bundle and run the following:
gradlew setupDecompWorkspace
##IDE
###Eclipse
###IntelliJ
gradlew setupDecompWorkspace
gradlew ideaModule
##Compile the example mod
###Download the Growthcraft repo
###Compile growthcraft and test with forge
###Submit Your Pull Request for Review After you have a working copy of your feature or bugfix, commit your changes and submit a pull request from your branch to the development branch. Your changes do not need to be production ready, as the pull request will start our code review process. It is recommended though that your code is near production ready as it will speed up the review process and get your changes committed sooner rather than later. If your branch will not compile, we will close out your pull request and you will need to submit another PR after you have your code compiling.
###Review Process Our review process requires that at least two contributors review and vet your changes. During this time the contributors will provide feedback and identify any problematic code. Expect to make changes during this process.
After you have full filled the needed changes identified by the contributors, the Pull Request will be marked for merging and tagged with a milestone. At this point your changes should show up in the next release.
[General Information](General Information)
In-Game Documentation
Growthcraft Apples
Growthcraft Bamboo
Growthcraft Bees
Growthcraft Cellar
Growthcraft Cellar - Yeast
Growthcraft Fishtrap
Growthcraft Grapes
Growthcraft Hops
Growthcraft Milk
Growthcraft Rice
API Documentation
Dev Documentation
Module Contribution Guide
How-To Build Growthcraft
Modpack Documentation