reschke commented on code in PR #2745: URL: https://github.com/apache/jackrabbit-oak/pull/2745#discussion_r2884596008
########## AGENTS.md: ########## @@ -0,0 +1,236 @@ +# AGENTS.md - AI Agent Instructions for Apache Jackrabbit Oak + +## Project Overview + +Apache Jackrabbit Oak is a scalable, high-performance hierarchical content repository +implementing the JCR (Java Content Repository) specification. It is a multi-module Maven +project with ~47 modules written in Java 11. + +## General Guidelines + +- When working on a specific area, first read the area-specific documentation before + making changes (see doc links in the module tables below) +- New code must have high test coverage — all critical paths must be covered by tests +- Write self-descriptive, easy-to-read code. Avoid trivial comments. Only add comments + where the logic is complex and not obvious from the code itself +- Use feature toggles for non-trivial changes. If the change is a bug fix, the toggle + should be enabled by default. If the change introduces a new feature, the toggle should + be disabled by default Review Comment: The key word is "automatically". This also misses information about how internal APIs are labeled, and what changing version numbers actually means in terms of what breaks. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
