CONTRIBUTING.md

Contributing guidelines

Pull Request Checklist

Before sending your pull requests, make sure you followed this list:

• Read Contributing Guidelines.
• Read Code of Conduct.
• Refer to Development process.
• Kobby Gradle and Maven plugins have identical public settings. If you change it, do it synchronously in both plugins.
• Build the project locally.
• Run Unit Tests and ensure that you have the test coverage for your code.

Development process

Please follow the steps below in order to make the changes:

1. Fork the repository

2. Set the local java version to 11

3. Open repository in your favourite IDE.

4. Make code changes to the Kobby Plugin.

5. Build and install the Kobby Plugin locally.

   # This will build and install both the Gradle and the Maven plugin 
   # to your local maven repository without test execution.
   ./gradlew clean build publishToMavenLocal -x test --stacktrace

6. The easiest way to test and debug your changes is to use the Kobby Example Projects.

   First find SNAPHOT plugin version in the gradle.properties file. It looks like:

   version = 1.1.1-SNAPSHOT

   1. Kobby Gradle Example

      Clone Kobby Gradle Example project and change build.gradle.kts file in cinema-api module.

      // Change from:
      plugins {
          kotlin("jvm")
          `java-library`
          id("io.github.ermadmi78.kobby") version "1.1.0"
      }

      // To:
      plugins {
          kotlin("jvm")
          `java-library`
      }
      
      buildscript {
          dependencies {
              classpath("io.github.ermadmi78:kobby-gradle-plugin:1.1.1-SNAPSHOT")
          }
      }
      
      apply(plugin = "io.github.ermadmi78.kobby")       

      Build the example:

      ./gradlew clean build

   2. Kobby Maven Example

      Clone Kobby Maven Example project and change pom.xml file.

       <!--  Change from: -->
       <properties>
           <!--  ... skipped -->
           <kobby.version>1.1.0</kobby.version>
           <!--  ... skipped -->
       </properties>

       <!--  To: -->
       <properties>
           <!--  ... skipped -->
           <kobby.version>1.1.1-SNAPSHOT</kobby.version>
           <!--  ... skipped -->
       </properties>

      Build the example:

      ./mvnw clean package

7. Make sure that Kobby Example Projects are compiling and running.

8. Actualize old testcases

   1. Run this command to actualize old testcases:

      ./gradlew clean build -Dkobby.testcases.actualize=true

   2. Look at the local changes in Git to make sure the generated code is correct for the old testcases.

   3. Commit actualized testcases.

   4. Rebuild the project to make sure the testcases are correct.

      ./gradlew clean build --stacktrace

9. Please don't forget to write new testcases for new features!!!