Skip to content
This repository has been archived by the owner on Dec 19, 2022. It is now read-only.

Latest commit

 

History

History
38 lines (27 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.94 KB
Raw

// Modified by SignalFx

Contributing

Pull requests for bug fixes are welcome, but before submitting new features or changes to current functionality open an issue and discuss your ideas or propose the changes you wish to make. After a resolution is reached a PR can be submitted for review.

Code Style

This project includes a .editorconfig file for basic editor settings. This file is supported by most common text editors.

Java files must be formatted using google-java-format. Please run the following task to ensure files are formatted before committing:

./gradlew googleJavaFormat

Other source files (Groovy, Scala, etc) should ideally be formatted by Intellij Idea's default formatting, but are not enforced.

Intellij IDEA

Compiler settings:

  • OpenJDK 11 must be installed to build the entire project. Under SDKs it must have the name 11.
  • Under Build, Execution, Deployment > Compiler > Java Compiler disable Use '--release' option for cross-compilation

Required plugins:

Suggested plugins and settings:

  • Editor > Code Style > Java/Groovy > Imports
    • Class count to use import with '*': 9999 (some number sufficiently large that is unlikely to matter)
    • Names count to use static import with '*': 9999
    • With java use the following import layout (groovy should still use the default) to ensure consistency with google-java-format: import layout
  • Google Java Format
  • Save Actions Recommended Settings