Skills Guide

Java Conventions for Contentstack Utils

VerifiedSafe

Style and structure guide for Java 17 code in the Contentstack Utils repo: packages, naming, JSON/Jsoup, Javadoc, and dependencies.

Download and use
Sby Skills Guide Bot
DevelopmentIntermediate
10/30/2026
Claude CodeCursorWindsurfCopilotCodex
#java#contentstack#coding-conventions#jsoup#javadoc

Recommended for

Backend developerClaude CodeCode reviewFrontend developerCursorCopilot

Automated summary

This skill defines the Java 17 coding conventions (packages, naming, JSON/Jsoup, Javadoc, dependencies) to follow in the Contentstack Utils repository.

Strengths

  • Clarifies the Java 17 target through maven-compiler-plugin and rules out legacy 1.8 properties
  • Lists production packages and expected naming conventions
  • Constrains dependencies (minimal footprint, no Lombok) and requires Javadoc on public APIs
  • Points to consistent internal references (testing, contentstack-utils-java, AGENTS.md)

Limitations

  • Tightly coupled to the Contentstack Utils repo layout, so hardly reusable elsewhere
  • Provides rules and pointers rather than full code examples
  • Test conventions are delegated to another file and thus not covered here
When to use it

Use it whenever editing any production or test .java file in this repository so style, packages and dependencies stay aligned.

When not to use it

Avoid it for a Java project outside this repository or when local conventions already differ.

Security analysis

Safe
Quality score75/100

This is a pure documentation/style-guideline skill for Java conventions. It contains no executable commands, no network or filesystem operations, no credential handling, and no attempts to alter agent behavior beyond normal coding guidance. The only mild observation is that it references other skill files (skills/testing/SKILL.md, skills/contentstack-utils-java/SKILL.md) and AGENTS.md, which are contextual pointers rather than risks.

No concerns found

How this analysis is made

Examples

Add a render helper
Add a small helper to the render package that builds a JSONObject from a Jsoup element, respecting the repo's Java 17 conventions and Javadoc rules.
Review dependency addition
I want to add a new library to pom.xml for HTML parsing. Check it against the Java skill rules on dependencies and Lombok before I proceed.
Fix compiler settings
Our pom.xml still has maven.compiler.source/target set to 1.8. Align it with the Java 17 conventions described in the java skill.

name: java description: Java 17, package layout, naming, JSON/Jsoup, Javadoc — use when editing any production or test Java in this repo

Java – Contentstack Utils (Java)

When to use

  • Editing any .java file under this repository.
  • Adding dependencies or debating style vs other Contentstack SDKs.

Instructions

Language and runtime

  • Java 17 via maven-compiler-plugin <release>17</release> in pom.xml. Ignore legacy maven.compiler.source/target 1.8 — the compiler plugin wins.
  • Avoid raw types; use generics where applicable.

Package and layout

  • Production code lives under com.contentstack.utils and subpackages: render, node, embedded, helper, interfaces.
  • Do not add new top-level packages without team alignment.

Naming

  • Classes: PascalCase (Utils, DefaultOption, AutomateCommon).
  • Methods / variables: camelCase.
  • Tests: Mixed conventions already in use — see skills/testing/SKILL.md.

JSON and HTML

  • Prefer org.json (JSONObject, JSONArray) for APIs and internals used by Utils and GQL.
  • Use Jsoup for RTE HTML; follow patterns in AutomateCommon and Utils.

Validation and utility types

  • javax.validation.constraints (e.g. @NotNull) on some public methods — keep Javadoc aligned with null behavior.
  • Private constructors for non-instantiable types where the codebase already does (GQL, AutomateCommon).

Dependencies

  • Small JAR consumed by the Contentstack Java SDK — prefer minimal dependencies; justify additions in pom.xml.
  • No Lombok in this repo unless explicitly adopted by the team.

Documentation

  • Javadoc on public API; examples must match real entry points (Utils.render, GQL.jsonToHTML, DefaultOption).

References

  • skills/contentstack-utils-java/SKILL.md — RTE, embedded, GraphQL shapes.
  • skills/testing/SKILL.md — test naming and layout.
  • AGENTS.md — tech stack summary.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/java-conventions-for-contentstack-utils-mvda8817/download' --output '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md.part' && mv '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md.part' '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

Original excerpt: Dependencies
  • Small JAR consumed by the Contentstack Java SDK — prefer minimal dependencies; justify additions in pom.xml.
  • No Lombok in this repo unless explicitly adopted by the team.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md' && test -s '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/java' && cp -R '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817' '.claude/skills/java'

Cursor
test -f '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md' && test -s '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/java' && cp -R '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817' '.cursor/skills/java'

Codex
test -f '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md' && test -s '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/java' && cp -R '.skill-downloads/java-conventions-for-contentstack-utils-mvda8817' '.agents/skills/java'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/java-conventions-for-contentstack-utils-mvda8817'

openskills read 'java-conventions-for-contentstack-utils-mvda8817'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

React Hook Form Best Practices

Development

Master React Hook Form: avoid anti-patterns, manage subscriptions, and handle reset, dirty state, and controlled inputs correctly.

Claude CodeCursorWindsurf+2intermediateSafe 108,623
Skills Guide Bot

Emotion to Mantine Migration

Development

Migrate Emotion styled-components to Mantine components with style props and CSS modules. Use when converting .styled.tsx files or removing @emotion imports.

Claude CodeCursorWindsurf+1intermediateSafe 48,981
Skills Guide Bot

Scope Creep Detector

Development

Analyzes git diffs against a stated intent to detect scope creep, unrelated files, broad PRs, and oversized changes, then suggests keep, split, or justify actions.

Claude CodeCursorCodexintermediateSafe 135,015
Skills Guide Bot