Junie Guidelines

A catalog of technology-specific guidelines for optimizing Junie code generation.

Junie is an AI agent for JetBrains IDEs including IntelliJ IDEA, PyCharm, WebStorm, GoLand, PhpStorm, RubyMine, RustRover and Rider.

Purpose of the guidelines?

These guidelines capture the coding conventions and best practices your team agrees to follow.

They can be provided to AI agents so that any generated code aligns with your standards.

Beyond AI-assisted development, they serve as a reference for developers to learn common practices and understand the reasoning behind them.

These guidelines cover:

• Preferred coding styles and naming conventions
• Recommended best practices
• Common antipatterns to avoid
• Real-world code examples accompanied by clear explanations

How to use the guidelines in Junie?

You can define your coding style, best practices, and general preferences in .junie/AGENTS.md or AGENTS.md. Alternatively, you can specify a custom path to the guidelines in the IDE settings (Settings | Tools | Junie | Project Settings).

For more information, see Junie Documentation.

Table Of Contents

• Junie Guidelines
  • How to use the guidelines in Junie?
  • Contents
  • Guidelines
    • Java
    • Python
    • Go
  • Contributing

Guidelines Catalog

Java

• Java (with Explanations)
• Spring Boot (with Explanations)

TypeScript

• Nuxt (with Explanations)

Python

• Django (with Explanations)

Go

• Gin-Gonic (with Explanations)

Contributing

Contributions are always welcome! Please check out the contributing guidelines.