README.md

checkstyle

Intro

Правила описываются с помощью плагина Checkstyle http://checkstyle.sf.net/.

Для соблюдения всеми разработчиками Coding Style, необходимо включить проверку на стадию Continuous Integration с помощью плагинов:

• Apache Maven Checkstyle Plugin
• Gradle Checkstyle Plugin

Project Structure

Структура проекта должна соответствовать Standard Directory Layout.

Apache Maven

project-name
├── pom.xml
├── .gitignore
├── LICENSE
├── CHANGELOG.md
├── README.md
└── src
    ├── docker
    │   └── Dockerfile
    ├── itest
    │   ├── java
    │   ├── kotlin
    │   └── resources
    ├── main
    │   ├── java
    │   ├── kotlin
    │   └── resources
    └── test
        ├── java
        ├── kotlin
        └── resources

Gradle

project-name
├── build.gradle
├── gradle.properties
├── setting.gradle
├── .gitignore
├── LICENSE
├── CHANGELOG.md
├── README.md
└── src
    ├── docker
    │   └── Dockerfile
    ├── itest
    │   ├── java
    │   ├── kotlin
    │   └── resources
    ├── main
    │   ├── java
    │   ├── kotlin
    │   └── resources
    └── test
        ├── java
        ├── kotlin
        └── resources

Source File

Encoding

Файлы с исходным кодом должны быть в кодировке UTF-8.