From 1124923cf1bc6a57fa93394c5d3ba560b299b7ee Mon Sep 17 00:00:00 2001 From: Tyler Benson Date: Mon, 30 Jul 2018 15:54:48 +1000 Subject: [PATCH] Add contributing document --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..6d14ed6002 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +### Contributing + +Pull requests for bug fixes are welcome, but before submitting new features or changes to current functionality [open an issue](https://github.com/DataDog/dd-trace-java/issues/new) +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](https://github.com/google/google-java-format). Please run the following task to ensure files are formatted before committing: + +```shell +./gradlew :googleJavaFormat +``` + +Other source files (Groovy, Scala, etc) should ideally be formatted by Intellij Idea's default formatting, but are not enforced. + +### Intellij Idea + +Suggested plugins and settings: + +* Editor > Code Style > Java/Groovy > Imports + * Class count to use import with '*': `10` (some number sufficiently large that is unlikely to matter) + * Names count to use static import with '*': `10` +* [Google Java Format](https://plugins.jetbrains.com/plugin/8527-google-java-format) +* [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) + ![Recommended Settings](https://user-images.githubusercontent.com/734411/43379477-fc2c0bb6-940f-11e8-858d-5c251bcac3c8.png) +* [Lombok](https://plugins.jetbrains.com/plugin/6317-lombok-plugin)