Files
ClipCoffre/AGENTS.md
2026-01-17 13:10:10 +01:00

2.2 KiB

Repository Guidelines

discussion et commentaire de code en francais

Project Structure & Module Organization

  • Current repository is a minimal scaffold. Top-level files: README.md, CLAUDE.md, and this guide.
  • Product requirements and expected extension layout are documented in CLAUDE.md (GNOME Shell extension with src/, schemas/, stylesheet.css, etc.). Add those directories when implementation begins.
  • Keep user-facing docs in the root (e.g., README.md, CHANGELOG.md, TODO.md).

Build, Test, and Development Commands

  • No build, test, or run commands are defined yet. When adding them, document in README.md and mirror here.
  • Expected future examples (from CLAUDE.md) include schema compilation and install scripts, e.g.:
    • glib-compile-schemas schemas/ (compile GSettings schemas)
    • ./install.sh (install the extension into the GNOME extensions directory)

Coding Style & Naming Conventions

  • No formatter or linter is configured. Match existing file style and keep changes consistent within each file.
  • For GNOME Shell extension code (GJS), follow GNOME JavaScript conventions and keep names descriptive (e.g., popupSecrets.js, clipboardService.js).
  • Use clear file names and keep modules focused by responsibility.

Testing Guidelines

  • No automated tests exist yet. If you add tests, document the framework and naming convention (e.g., *.test.js).
  • Maintain a manual checklist in README.md or TODO.md for core behaviors until automated tests exist.

Commit & Pull Request Guidelines

  • Git history is minimal and does not define a commit message convention. Use short, imperative summaries (e.g., "Add secrets storage service").
  • For PRs (if applicable), include: a brief description, any linked issues, and screenshots/GIFs for UI changes.

Security & Configuration Tips

  • Follow the security notes in CLAUDE.md, especially around secret handling and file permissions.
  • Avoid logging sensitive data and keep any local data stores under user-only permissions.

Agent-Specific Instructions

  • CLAUDE.md contains the authoritative product and architecture requirements for this repository. Review it before implementing features.