JETLS.jl AGENTS.md

Formatting

Code formatting

• When writing Julia code, use 4 whitespaces for indentation and try to keep the maximum line length under 92 characters.
• AI agents must not run automated formatters unless explicitly requested by a human in the current conversation. This includes file-wide or project-wide formatting commands and editor-integrated formatting tools. When editing code, preserve the surrounding formatting and make only minimal local edits. If formatting seems necessary, ask before applying it.

Markdown formatting

When writing Markdown text, use 2 whitespaces for indentation and try to keep the maximum line length under 80 characters.

• Exception: CHANGELOG.md is exempt from line length rules since it is used for GitHub release notes, where hard line breaks disrupt rendering.
• Additionally, prioritize simple text style and limit unnecessary decorations (e.g. **) to only truly necessary locations. This is a style that should generally be aimed for, but pay particular attention when writing Markdown.
• Headers should use sentence case (only the first word capitalized), not title case. For example:
  • Good: ## Conclusion and alternative approaches
  • Bad: ## Conclusion And Alternative Approaches

Commit message formatting

When writing commit messages, follow the format "component: Brief summary" for the title.

In the body, write paragraphs in this order:

1. Explain the concrete problem or user-visible limitation being fixed. If appropriate, include a small code example when it makes the issue clearer.
2. Explain the approach used to fix the problem.
3. Mention important caveats, follow-up work, performance notes, or test coverage when relevant.

Use backticks for code elements (function names, variables, file paths, etc.) to improve readability.

Ensure that the maximum line length never exceeds 72 characters. When referencing external GitHub PRs or issues, use proper GitHub interlinking format (e.g., "owner/repo#123" for PRs/issues). Finally, if you write code yourself, include a co-author trailer at the end of the commit message, e.g.: Co-Authored-By: GPT-5.5 <[email protected]> (adjust the model name as appropriate). However, when simply asked to write a commit message, there's no need to add that trailer.