docs: add AGENTS.md, CONTRIBUTING.md, and LICENSE (GTI-848)#26
Merged
Conversation
- Add CONTRIBUTING.md: setup, architecture, workflow, testing, code style, demos, PR/commit conventions, and resources - Add AGENTS.md: agent guide covering build/test/release model, module map, working rules, and CI workflows - Add MIT LICENSE (resolves dangling README link) - Expand README with architecture, core use cases, repository structure, and dependency/runtime model - Gitignore .claude/ and specs/ Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🛡️ Jit Security Scan Results
✅ No security findings were detected in this PR
Security scan by Jit
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds contributor- and agent-facing documentation, an MIT license, and supporting README/gitignore updates. Doc-only — no source or build changes.
@Tagslow/integration + VCR), code style (Spotless/google-java-format), adding demos, PR checklist, Conventional Commits, and resources.redis-om-springrepo, adapted to this repo's facts (Java 17 target/JDK 21 toolchain, tests colocated incore/, google-java-format).[LICENSE](LICENSE)link in the README)..claude/andspecs/.Notes
build.gradle.kts/core/build.gradle.kts(Jedis 7.3.0, LangChain4J 0.36.2, Spring AI 1.1.0, ONNX 1.16.3,slow/integrationtag exclusion,integrationTest/slowTesttasks).🤖 Generated with Claude Code
Note
Low Risk
Documentation and licensing only; no runtime, API, or CI build logic changes.
Overview
Adds contributor and AI-agent documentation, an MIT
LICENSE, and small README /.gitignoreupdates—no library or Gradle changes.CONTRIBUTING.mdcovers setup (JDK 21 toolchain, Docker/Testcontainers), module layout, workflow (spotlessApply,:core:test,integrationTest/slowTest), VCR modes, code style, demo registration, and PR/commit conventions.AGENTS.mdis a fast path for coding agents: capabilities, module map, build/verify commands, test tagging, CI/release cautions, and local-onlyspecs/workflow (aligned with patterns from sibling repos).LICENSEsupplies the MIT text so the existing README license link resolves.README.mdgains Core Use Cases, Repository Structure, and Dependency & Runtime Model (Java 17 vs JDK 21, optional LangChain4J/Spring AI, ONNX)..gitignorenow ignores.claude/andspecs/.Reviewed by Cursor Bugbot for commit 8be714e. Bugbot is set up for automated code reviews on this repo. Configure here.