New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation regarding IDE plugins and code formatting #20

Open

alexjhawk opened this issue Jun 14, 2023 · 0 comments

Labels

Collaborator

alexjhawk commented Jun 14, 2023

Add IntelliJ, Eclipse, and/or VS Code documentation with information about the required or optional IDE plugins and code formatting options.

This should include recommended plugin settings and code format XML configurations as required.

For example, the following information about IntelliJ may be included:

Required Plugin: Google Java Format

Required Configuration Mode: Default Google Java Format

Recommended Plugin: Save Actions

Recommended Configuration Mode: Optimize Imports, Reformat Code

Required Code Format XML Definition

https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
Required: Import to IntelliJ and Set as Project Default
Recommended: Set as IDE Default

alexjhawk added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment