Skip to content

agents.md

Latest commit

 

History

History
71 lines (56 loc) · 3.12 KB

agents.md

File metadata and controls

71 lines (56 loc) · 3.12 KB

AI Agent Guidelines for ownCloud Documentation

This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cursor, etc.) working in this repository.

Repository Overview

  • Product family: Documentation
  • Primary language(s): JavaScript
  • Build system: npm (Antora)
  • Test framework: Antora build (npm run antora); link checking is documented in docs/checking-broken-links.md
  • CI system: GitHub Actions

Architecture & Key Paths

  • site.yml -- Antora playbook defining all content sources
  • package.json -- npm scripts for building and serving
  • ext-antora/ -- Custom Antora extensions
  • ext-asciidoc/ -- Custom AsciiDoc extensions
  • docs/ -- Documentation about the docs build system itself
  • resources/ -- Shared resources
  • fonts/ -- Custom fonts
  • supplemental/ -- Supplemental UI files
  • book_templates/ -- PDF book templates

Development Conventions

  • Branching: master
  • Commit messages: DCO sign-off required (git commit -s)
  • Code style: Prettier (.prettierrc or similar config present)
  • PR process: Open a PR against master. All CI checks must pass.

Build & Test Commands

# Build
npm run antora

# Test
# No automated test suite; verify by building (npm run antora).
# Link checking is documented in docs/checking-broken-links.md.

# Lint
Not detected (Prettier config present for formatting)

Important Constraints

  • All code contributions must be compatible with the AGPL-3.0 license
  • Do not introduce new copyleft-licensed dependencies (GPL, AGPL, LGPL, MPL) without explicit discussion in an issue first. This is especially important for repos migrating to Apache 2.0.
  • Do not introduce new dependencies without discussion in an issue first

OSPO Policy Constraints

GitHub Actions

  • Only use actions owned by owncloud, created by GitHub (actions/*), verified on the GitHub Marketplace, or verified by the ownCloud Maintainers.
  • Pin all actions to their full commit SHA (not tags): uses: actions/checkout@<SHA> # vX.Y.Z
  • Never introduce actions from unverified third parties.

Dependency Management

  • Dependabot is configured for automated dependency updates.
  • Review and merge Dependabot PRs as part of regular maintenance.
  • Do not introduce new dependencies without discussion in an issue first.

Git Workflow

  • Rebase policy: Always rebase; never create merge commits. Use git pull --rebase and git rebase before pushing.
  • Signed commits: All commits must be PGP/GPG signed (git commit -S -s).
  • DCO sign-off: Every commit needs a Signed-off-by line (git commit -s).
  • Conventional Commits & Squash Merge: Use the Conventional Commits format where the repository enforces it. Many repos use squash merge, where the PR title becomes the commit message on the default branch — apply Conventional Commits format to PR titles as well. A reusable GitHub Actions workflow enforces this.

Context for AI Agents

  • Match existing code style
  • Do not refactor unrelated code in the same PR
  • Write tests for new functionality
  • Keep PRs focused and atomic