From 8e3f4abe924efce8535938554898658d223d5c80 Mon Sep 17 00:00:00 2001 From: Joakim Olsson Date: Fri, 9 Jan 2026 10:15:34 +0100 Subject: [PATCH] docs: add CLAUDE.md for Claude Code guidance Provides project overview, build commands, structure, and CI/CD info for AI-assisted development. Co-Authored-By: Claude Opus 4.5 --- .claude/settings.local.json | 7 +++++++ CLAUDE.md | 40 +++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 .claude/settings.local.json create mode 100644 CLAUDE.md diff --git a/.claude/settings.local.json b/.claude/settings.local.json new file mode 100644 index 0000000..247e14d --- /dev/null +++ b/.claude/settings.local.json @@ -0,0 +1,7 @@ +{ + "permissions": { + "allow": [ + "Bash(but status:*)" + ] + } +} diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..d27ad4c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,40 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +This is a Docker image project for Robot Framework test automation. It packages Robot Framework with commonly used testing libraries and browser drivers (Firefox, Chrome) into a containerized environment for running automated tests. + +## Build Commands + +The project uses `build-tools` (not Docker buildx) for building: +```bash +build # Build the Docker image +push # Push the image to registry +``` + +## Project Structure + +- `Dockerfile` - Main container definition based on Python slim, installs browsers and RF libraries +- `requirements.txt` - Python dependencies (Robot Framework + libraries) +- `.version` - JSON file containing the current version +- `cliff.toml` - git-cliff configuration for changelog generation +- `.gitea/workflows/ci.yaml` - CI pipeline (builds on push/PR to main) + +## Key Libraries Included + +- robotframework-browser (Playwright-based) +- robotframework-seleniumlibrary +- robotframework-appiumlibrary +- robotframework-databaselibrary (with PostgreSQL/MySQL drivers) +- robotframework-requests +- robotframework-httplibrary + +## Versioning + +The project uses semantic versioning. Version is stored in `.version` as JSON. Changelog is auto-generated using git-cliff with conventional commits. + +## CI/CD + +Uses Gitea Actions. The pipeline runs `build` and `push` on main branch and pull requests.