Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 2.34 KB
Raw

Table of Content

to update toc, please read this page.

Introduction

The project is code in Kotlin because handle NullPointerException is a nightmare. Moreover, Kotlin brings lots of cool features. If you are a Java developer learning curve is really smooth. JetBrains has published a really good MOOC

You can setup your environment by following this guide. To learn more about the project architecture please read this document

Contribution

If you are contributing code, please consider the following:

  • code should be accompanied by test when possible
  • all tests must passed
  • add link to IntelliJ SDK documentation in JavaDoc, if the SDK documentation does not exist, please write a section in project architecture.

Developer Certificate Of Origin

The OPA project requires that contributors sign off on changes submitted to OPA repositories. As opa-idea-plugin is now part of the OPA repositories, opa-idea-plugin requires contributors sign off on changes as well. The Developer Certificate of Origin (DCO) is a simple way to certify that you wrote or have the right to submit the code you are contributing to the project.

The DCO is a standard requirement for Linux Foundation and CNCF projects.

You sign-off by adding the following to your commit messages:

This is my commit message

Signed-off-by: Random J Developer <[email protected]>

Git has a -s command line option to do this automatically.

git commit -s -m 'This is my commit message'

You can find the full text of the DCO here: https://developercertificate.org/

Helpful resources