Skip to content

agents.md

Latest commit

 

History

History
68 lines (54 loc) · 2.74 KB

agents.md

File metadata and controls

68 lines (54 loc) · 2.74 KB
Raw

AI Agent Guidelines for Shell Integration (Dolphin)

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

Repository Overview

  • Product family: Desktop Client
  • Primary language(s): C++
  • Build system: CMake
  • Test framework: None detected
  • CI system: GitHub Actions

Architecture & Key Paths

  • src/ - C++ source code for the Dolphin plugin
  • CMakeLists.txt - CMake build configuration
  • COPYING - GPL-2.0 license

Development Conventions

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

Build & Test Commands

# Build
mkdir build && cd build
cmake ..
cmake --build .

# Test
Not detected

# Lint
Not detected

Important Constraints

  • All code contributions must be compatible with the GPL-2.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
  • Requires KDE Frameworks 6 and Qt 6
  • This repo is in Maintenance mode

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
  • Icons are provided by the separate client-desktop-shell-integration-resources repository