This is an automated email from the ASF dual-hosted git repository. ottlinger pushed a commit to branch feature/RAT-558 in repository https://gitbox.apache.org/repos/asf/creadur-rat.git
commit 334dcc9307d5b83f5599a4cf0cef51865b316046 Author: P. Ottlinger <[email protected]> AuthorDate: Mon Jun 1 21:36:20 2026 +0200 RAT-558: Add AGENTS.md as a starting point --- AGENTS.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..40ea8eed --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,26 @@ +# 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
