creadur-rat

Imported from apache/creadur-rat (AGENTS.md). Install upstream with npx skills add apache/creadur-rat. Copyright stays with the author.

Agent guidance

This file is read by automated agents (security scanners, code analyzers, AI assistants) operating on this repository. It points them at the human-authored references they should consult before producing output.

SECURITY

• Before reporting any security finding, consult SECURITY.md and the full threat model in THREAT_MODEL.md.
• THREAT_MODEL.md defines RAT's scope, trust boundaries, the security properties RAT provides and disclaims, the adversary model, and the known non-findings used to triage scanner output.
• Report suspected vulnerabilities privately to security@apache.org; do not open public issues for them.

CODE STYLE

• Use consistent naming conventions
• Follow language-specific style guides
• Keep functions small and focused
• Use meaningful variable and function names
• Add comments for complex logic
• Add package-info.java to each new package in the source tree

BEST PRACTICES

• DRY (Don't Repeat Yourself): Avoid code duplication
• SOLID Principles: Follow object-oriented design principles
• Error Handling: Always handle potential errors gracefully
• Security: Consider security implications in your code
• Version Control: Write clear commit messages, referencing Apache Creadur Jira tickets if possible

COMMUNICATION

• Explain your approach before implementing
• Break down complex solutions into steps
• Provide examples when helpful
• Ask clarifying questions when requirements are unclear

RESTRICTIONS

• Always ask before making breaking changes
• Don't add unnecessary dependencies
• Follow the existing codebase patterns and conventions
• Test your solutions when possible with unit or integration tests