You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@sling.apache.org by "cziegeler (via GitHub)" <gi...@apache.org> on 2026/06/01 21:44:13 UTC

[PR] docs: add AGENTS.md, CLAUDE.md, and expand README [sling-org-apache-sling-jcr-oak-server]

cziegeler opened a new pull request, #19:
URL: https://github.com/apache/sling-org-apache-sling-jcr-oak-server/pull/19

   Adds AI agent context files and improves the project README with richer documentation.
   
   - Added `AGENTS.md` with a full project overview, core Maven commands, repository layout, development constraints, Git workflow, testing guidelines, and common gotchas for AI coding agents
   - Added `CLAUDE.md` that delegates to `AGENTS.md` via `read @AGENTS.md`
   - Expanded `README.md` with:
     - Improved introductory description of what the bundle does
     - Fixed typo (`paring` → `pairing`) and rephrased compatibility table header
     - Added version rows for 1.4.4 and 1.4.5-SNAPSHOT
     - New "Build and test" section with common Maven commands
     - New "Key implementation notes" section summarising Java version, OSGi annotations, Lucene config, and optional imports
     - New "Repository layout" section listing main and test source files
   
   Co-authored-by: Maia <ma...@noreply>


-- 
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: dev-unsubscribe@sling.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: add AGENTS.md, CLAUDE.md, and expand README [sling-org-apache-sling-jcr-oak-server]

Posted by "sonarqubecloud[bot] (via GitHub)" <gi...@apache.org>.
sonarqubecloud[bot] commented on PR #19:
URL: https://github.com/apache/sling-org-apache-sling-jcr-oak-server/pull/19#issuecomment-4596795923

   ## [![Quality Gate Passed](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/QualityGateBadge/qg-passed-20px.png 'Quality Gate Passed')](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-jcr-oak-server&pullRequest=19) **Quality Gate passed**  
   Issues  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/passed-16px.png '') [0 New issues](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-jcr-oak-server&pullRequest=19&issueStatuses=OPEN,CONFIRMED&sinceLeakPeriod=true)  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/accepted-16px.png '') [0 Accepted issues](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-jcr-oak-server&pullRequest=19&issueStatuses=ACCEPTED)
   
   Measures  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/passed-16px.png '') [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-jcr-oak-server&pullRequest=19&issueStatuses=OPEN,CONFIRMED&sinceLeakPeriod=true)  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/passed-16px.png '') [0.0% Coverage on New Code](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-jcr-oak-server&pullRequest=19&metric=new_coverage&view=list)  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/passed-16px.png '') [0.0% Duplication on New Code](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-jcr-oak-server&pullRequest=19&metric=new_duplicated_lines_density&view=list)  
     
   <!-- sqra-placement-anchor -->
   [See analysis details on SonarQube Cloud](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-jcr-oak-server&pullRequest=19)
   
   


-- 
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: dev-unsubscribe@sling.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs: add AGENTS.md, CLAUDE.md, and expand README [sling-org-apache-sling-jcr-oak-server]

Posted by "cziegeler (via GitHub)" <gi...@apache.org>.
cziegeler merged PR #19:
URL: https://github.com/apache/sling-org-apache-sling-jcr-oak-server/pull/19


-- 
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: dev-unsubscribe@sling.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org