CONTRIBUTING.adoc

Contributing

Branch naming convention

In order to keep branches clear and expressive, please use the following prefixes:

• feature/ when implementing a new feature

• fix/ when fixing a bug/issue

• improvement/ when improving the code base (both production code and test code)

Test the project locally

$ git clone https://github.com/RoRoche/plantuml-gradle-plugin
$ git fetch

Then in the build.gradle file, change the line 18 to set the version you want.

Then publish it to local Maven using ./gradlew publishToMavenLocal

In another Gradle-based project, define the Local Maven repository for plugin management in settings.gradle such as:

settings.gradle

pluginManagement {
    repositories {
        gradlePluginPortal()
        mavenLocal()
    }
}

Then, in the build.gradle file:

build.gradle

plugins {
    id "com.github.roroche.plantuml" version "{version}"
}

classDiagram {
    packageName = "{your_package}"
    outputFile = project.file('diagrams/class_diagram.plantuml')
}

Finally, launch task ./gradlew buildClassDiagram