Skip to content

agents.md

Latest commit

 

History

History
71 lines (57 loc) · 3.12 KB

agents.md

File metadata and controls

71 lines (57 loc) · 3.12 KB
Raw

AI Agent Guidelines for Android Scenario Testing

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): Java, Gherkin
  • Build system: Gradle
  • Test framework: Cucumber, Appium, JUnit
  • CI system: GitHub Actions

Architecture & Key Paths

  • src/test/resources/io/cucumber/ - Gherkin feature files
  • src/ - Java step definitions and test infrastructure
  • buildapk/ - Script to build the ownCloud Android app for testing
  • executeTests - Script to launch the test suite
  • server/ - Server setup and configuration
  • build.gradle - Gradle build configuration
  • runAppium.sh - Appium server launcher

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.

Build & Test Commands

# Build
./gradlew build

# Test
./executeTests

# Build APK for testing
./buildapk/buildAPK.sh

Important Constraints

  • All code contributions must be compatible with the MIT 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
  • Tests require a running Appium server and an Android device/emulator
  • Tests require a running ownCloud server (oCIS or OC10)

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
  • Feature files use Gherkin syntax - follow existing patterns for new scenarios
  • Step definitions are in Java - follow existing naming conventions