Skip to content

CLAUDE.md

Latest commit

 

History

History
63 lines (40 loc) · 2.46 KB

CLAUDE.md

File metadata and controls

63 lines (40 loc) · 2.46 KB

CLAUDE.md

Project overview

EVES (ENVITED-X Verifiable Ecosystem Specifications) defines standards for the ENVITED-X Data Space. Each specification lives in EVES/EVES-NNN/eves-nnn.md with associated examples, schemas, and assets.

Setup

npm install
pre-commit install

Quality checks

Before every commit, run:

make lint          # markdownlint + frontmatter validation
make format-check  # Prettier formatting

Pre-commit hooks enforce: trailing whitespace, end-of-file newlines, valid YAML/JSON, no merge conflicts, markdownlint, Prettier formatting (check mode), and Vale prose linting.

If Prettier fails, run npx prettier --write . to auto-format, then re-stage and commit.

CI additionally runs link checking (link_checker.yml).

Vale prose lint rules

The project uses Vale with Google, proselint, and write-good styles (see .vale.ini). Several rules are disabled because they conflict with technical specification conventions (see comments in .vale.ini).

Key active rule that causes CI failures:

  • Use "for example" instead of "e.g." or "i.e." (Google.Latin)

To run Vale locally: install Vale, then vale sync && vale EVES/.

Markdown lint rules

See .markdownlint.json. Maximum line length is 300 characters (tables and code blocks are exempt). HTML elements <a>, <br>, <img>, <sup> are allowed.

File conventions

  • Specification documents use YAML frontmatter with fields: eves-identifier, title, author, status, type, created, requires, replaces
  • JSON schemas go in eves-nnn-schemas/ directories (excluded from Prettier in .prettierignore)
  • Example files go in example/ directories (excluded from Prettier in .prettierignore)
  • Commit messages follow Conventional Commits with scope: feat(EVES-003): ..., fix(ci): ...
  • Branches follow feat/eves-nnn-description naming

Ontology references

The ENVITED-X ontologies are maintained in ontology-management-base. Current versions: envited-x/v3/, manifest/v5/, hdmap/v6/.

The Gaia-X ontology follows the Loire (25.11) release. Key naming:

  • envited-x:ResourceDescription (subclass of gx:VirtualResource) carries the GX compliance metadata
  • gx:name, gx:description are used in the envited-x:ResourceDescriptionShape SHACL
  • gx:license, gx:copyrightOwnedBy, gx:resourcePolicy remain GX-native properties