Can i request for Adding comments in build.gradle/config.gradle

akhikhl / multiproject-git-gradle

Gradle script for multi-project git-based setup, configuration and build

30 stars 12 forks source link

Can i request for Adding comments in build.gradle/config.gradle #9

Open kavink opened 10 years ago

kavink commented 10 years ago

Please can i request the following:

Can we have detailed comments in build.gradle and config.gradle. Which will help anyone willing to contribute.
Also if we can add CONTRIBUTING.md with guidelines for anyone intending to contribute to this project.

akhikhl commented 10 years ago

Regarding comments in "build.gradle" - I am thinking of converting the whole thing to gradle plugin first. It was OK as a single script, when it was small. Now the thing is big enough to be split into classes and properly packaged as a gradle plugin. I'd rather start with documenting source code when it is already converted to gradle plugin.

kavink commented 10 years ago

Thanks that works too! But also an important note is memory usage by the plugin or this project!

Also will be helpful if there was a gradlew script, gradle.properties with GRADLE_OPTS property in it with bumped up memory requirements.