Guidelines for repository contributors

CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team in 
+[GitHub Discussions](https://github.com/kobylynskyi/graphql-java-codegen/discussions). 
+All complaints will be reviewed and investigated and will result in a response 
+that is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,107 @@
+# Contributing guidelines
+
+## Pull Request Checklist
+
+Before sending your pull requests, make sure you followed this list:
+
+- Read [Contributing Guidelines](CONTRIBUTING.md).
+- Read [Code of Conduct](CODE_OF_CONDUCT.md).
+- Refer to [Development process](#development-process).
+- Kobby Gradle and Maven plugins have
+  identical [public settings](https://github.com/ermadmi78/kobby/wiki/Available-Gradle-Plugin-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. Clone the repository
+1. Set the local java version to 11
+1. Checkout **develop** branch.
+1. Open repository in your favourite IDE.
+1. Make code changes to the Kobby Plugin.
+1. Build and install the Kobby Plugin locally.
+
+   ```shell script
+   # This will build and install both the Gradle and the Maven plugin 
+   # to your local maven repository.
+   ./gradlew clean build
+   ```
+
+1. 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](https://github.com/ermadmi78/kobby/blob/main/gradle.properties) file. It looks like:
+
+   ```properties
+   version = 1.1.1-SNAPSHOT
+   ```
+
+    1. Kobby Gradle Example
+
+       Clone [Kobby Gradle Example](https://github.com/ermadmi78/kobby-gradle-example) project and
+       change [build.gradle.kts](https://github.com/ermadmi78/kobby-gradle-example/blob/main/cinema-api/build.gradle.kts)
+       file in `cinema-api` module.
+
+       ```kotlin
+       // Change from:
+       plugins {
+           kotlin("jvm")
+           `java-library`
+           id("io.github.ermadmi78.kobby") version "1.1.0"
+       }
+       ```
+
+       ```kotlin
+       // 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:
+
+       ```shell script
+       ./gradlew clean build
+       ```
+    1. Kobby Maven Example
+
+       Clone [Kobby Maven Example](https://github.com/ermadmi78/kobby-maven-example) project and
+       change [pom.xml](https://github.com/ermadmi78/kobby-maven-example/blob/main/pom.xml) file.
+
+       ```xml
+        <!--  Change from: -->
+        <properties>
+            <!--  ... skipped -->
+            <kobby.version>1.1.0</kobby.version>
+            <!--  ... skipped -->
+        </properties>
+       ```
+
+       ```xml
+        <!--  To: -->
+        <properties>
+            <!--  ... skipped -->
+            <kobby.version>1.1.1-SNAPSHOT</kobby.version>
+            <!--  ... skipped -->
+        </properties>
+       ```
+
+       Build the example:
+
+       ```shell script
+       ./mvnw clean package
+       ```
+
+1. Make sure that Kobby Example Projects are compiling and running.

README.md

@@ -19,6 +19,10 @@ See documentation in the [project wiki](https://github.com/ermadmi78/kobby/wiki)
 * Maven at least version 3.6.3 is required.
 * Kotlin at least version 1.5 is required to compile generated client DSL.
 
+### Contributing
+
+Please see [CONTRIBUTING.md](CONTRIBUTING.md)
+
 ### Gradle
 
 ```kotlin