Skip to content

Latest commit

History

History
43 lines (32 loc) · 2.38 KB

File metadata and controls

43 lines (32 loc) · 2.38 KB

Contentstack Java Delivery SDK – Agent guide

Universal entry point for contributors and AI agents. Detailed conventions live in skills/*/SKILL.md.

What this repo is

FieldDetail
Name:contentstack-java (com.contentstack.sdk:java)
Purpose:Java SDK for the Contentstack Content Delivery API (stack, entries, assets, queries, sync, etc.).
Out of scope:Not the Android or Swift SDKs—use those repositories for mobile-specific clients.

Tech stack (at a glance)

AreaDetails
LanguageJava 8 (maven.compiler.source/target in pom.xml)
BuildMaven (pom.xml); JaCoCo for coverage
TestsJUnit 5; unit tests and *IT integration tests under src/test/java/
Lint / coverageJaCoCo (jacoco:report in CI); no separate Checkstyle in quick path—follow existing style
CI.github/workflows/unit-testing.yml, check-branch.yml, sca-scan.yml, policy-scan.yml, codeql-analysis.yml, publish workflows

Commands (quick reference)

Command typeCommand
Build / testmvn clean test -Dgpg.skip=true (adjust -Dtest per pom.xml surefire notes)
Coverage (CI-style)mvn clean test -Dtest='Test*' jacoco:report -Dgpg.skip=true

Where the documentation lives: skills

SkillPathWhat it covers
Development workflowskills/dev-workflow/SKILL.mdBranches, Maven, CI, JaCoCo
Java CDA SDKskills/contentstack-java-cda/SKILL.mdPublic API: Stack, queries, callbacks, HTTP layer
Java style & layoutskills/java/SKILL.mdsrc/main/java packages, Lombok, Retrofit/Rx usage
Framework / HTTPskills/framework/SKILL.mdConfig, RetryOptions, CSHttpConnection, OkHttp/Retrofit flow
Testingskills/testing/SKILL.mdUnit vs integration tests, resources, credentials
Code reviewskills/code-review/SKILL.mdPR checklist for JVM SDK

Using Cursor (optional)

If you use Cursor, .cursor/rules/README.md only points to AGENTS.md—same docs as everyone else.