Skills Guide

Conventions Java pour Contentstack Utils

VérifiéSûr

Guide de style et de structure pour le code Java 17 du dépôt Contentstack Utils : packages, nommage, JSON/Jsoup, Javadoc et dépendances.

Télécharger et utiliser
Spar Skills Guide Bot
DeveloppementIntermédiaire
30/10/2026
Claude CodeCursorWindsurfCopilotCodex
#java#contentstack#coding-conventions#jsoup#javadoc

Recommandé pour

Développeur backendClaude CodeRevue de codeDéveloppeur frontendCursorCopilot

Synthèse automatique

Cette compétence fixe les conventions de codage Java 17 (packages, nommage, JSON/Jsoup, Javadoc, dépendances) à respecter dans le dépôt Contentstack Utils.

Points forts

  • Précise la cible Java 17 via maven-compiler-plugin et écarte les propriétés héritées 1.8
  • Liste les packages de production et les conventions de nommage attendues
  • Encadre les dépendances (minimalisme, pas de Lombok) et la Javadoc sur l'API publique
  • Renvoie vers des références internes cohérentes (testing, contentstack-utils-java, AGENTS.md)

Limites

  • Fortement liée au dépôt Contentstack Utils et à son arborescence, peu réutilisable ailleurs
  • Ne fournit pas d'exemples de code complets, seulement des règles et des pointeurs
  • Les conventions de tests sont déléguées à un autre fichier, donc non couvertes ici
Quand l'utiliser

À utiliser dès qu'on modifie un fichier .java de production ou de test dans ce dépôt afin d'aligner style, packages et dépendances.

Quand l'éviter

À éviter pour un projet Java hors de ce dépôt ou lorsque les conventions locales diffèrent déjà.

Analyse de sécurité

Sûr
Score qualité75/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.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

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.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

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. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Extrait original : 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.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

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 doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/java-conventions-for-contentstack-utils-mvda8817'

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

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/java-conventions-for-contentstack-utils-mvda8817/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires

Bonnes pratiques React Hook Form

Developpement

Maîtrisez React Hook Form : évitez les anti-patterns, gérez les abonnements, et traitez correctement reset, dirty state et entrées contrôlées.

Claude CodeCursorWindsurf+2intermediateSûr 108,623
Skills Guide Bot

Migration Emotion vers Mantine

Developpement

Migrer les styled-components Emotion vers des composants Mantine avec style props et modules CSS. Pour convertir .styled.tsx ou supprimer les imports @emotion.

Claude CodeCursorWindsurf+1intermediateSûr 48,981
Skills Guide Bot

Détecteur de dérive de périmètre

Developpement

Analyse les diffs git par rapport à une intention pour détecter la dérive de périmètre, fichiers non liés et PR trop larges, puis suggère de garder, diviser ou justifier.

Claude CodeCursorCodexintermediateSûr 135,015
Skills Guide Bot