Skip to content

agents.md

Latest commit

 

History

History
69 lines (55 loc) · 2.99 KB

agents.md

File metadata and controls

69 lines (55 loc) · 2.99 KB
Raw

AI Agent Guidelines for dav4android

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

Repository Overview

  • Product family: Mobile (Android)
  • Primary language(s): Kotlin
  • Build system: Gradle
  • Test framework: JUnit
  • CI system: None detected

Architecture & Key Paths

  • src/ - Library source code (Kotlin)
  • build.gradle - Gradle build configuration
  • gradle/ - Gradle wrapper
  • run-tests.sh - Test runner script
  • lombok.config - Lombok configuration

Development Conventions

  • Branching: master
  • Commit messages: DCO sign-off required (git commit -s)
  • Code style: No specific linter configured
  • PR process: Open a PR against master. All CI checks must pass.
  • Note: This is a fork of bitfire's dav4android and is in Archived/Legacy mode

Build & Test Commands

# Build
./gradlew build

# Test
./run-tests.sh

# Lint
Not detected

Important Constraints

  • All code contributions must be compatible with the MPL-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 that are migrating to or already under Apache 2.0, as copyleft dependencies would block or complicate that migration.
  • Do not introduce new dependencies without discussion in an issue first
  • This is a fork of bitfire's project - upstream changes may need to be considered
  • This repository is in legacy/archived status

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
  • Be aware that this is a fork - check if changes should go upstream first