docs: add CLAUDE.md for Claude Code guidance #262

Merged
argoyle merged 1 commits from docs/claude-md into main 2026-01-09 09:28:50 +00:00
2 changed files with 47 additions and 0 deletions
+7
View File
@@ -0,0 +1,7 @@
{
"permissions": {
"allow": [
"Bash(but status:*)"
]
}
}
+40
View File
@@ -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.