Initializes AI context files (.AI_README.md and .AI_HISTORY.md) for OpenShift Layered Product QE projects, ensuring best practices adherence and structured documentation.
Automatically sets up and maintains AI context documentation for OpenShift Layered Product Quality Engineering projects.
This skill ensures that AI agents working in OpenShift QE repositories have proper context by creating and maintaining structured documentation files (.AI_README.md and .AI_HISTORY.md). It enforces best practices from the RHP Wiki and helps maintain consistency across QE tooling projects.
**CRITICAL**: Upon first interaction in any directory, you MUST:
1. Check if `.AI_README.md` exists
- If missing, create it using the appropriate template below
- Use Root Directory Template for project root
- Use Sub-Directory Template for subdirectories with significantly different context
2. Check if `.AI_HISTORY.md` exists
- If missing, create it using the history template below
#### For Root Directories
Create `.AI_README.md` with this structure:
```markdown
[Brief description of what this project contains, its purpose, and main technologies used.]
[Any limitations, requirements, or rules to follow - e.g., coding standards, dependencies to avoid, performance requirements.]
- Start of new sessions.
- Session resume (when continuing from a previous conversation).
- Before writing NEW bash scripts or functions (not minor edits to existing code).
- When user explicitly requests best practices review.
[Important structural or design decisions - e.g., folder structure, design patterns, data flow.]
[Frequent operations or workflows - e.g., how to build, test, deploy, or common debugging steps.]
[Key dependencies, environment variables, setup instructions.]
[Links to relevant documentation, APIs, or resources.]
```
#### For Sub-Directories
Create simplified `.AI_README.md` when:
Template:
```markdown
[What this subdirectory contains and why it exists.]
[Any patterns, rules, or approaches specific to this area.]
[Important context that differs from root]
```
Initialize with:
```markdown
This file tracks important changes and decisions in this directory. Each entry is scoped to this directory only.
- Project initialized
```
Add entries when:
**Entry Format:**
```markdown
- Bullet point description of change.
- Why the change was made (if relevant).
- Any important context or decisions.
```
**Scope Rule:** Each `.AI_HISTORY.md` only tracks changes within its directory and subdirectories that don't have their own history file.
**MANDATORY**: Review RHP Wiki best practices at https://edttjredhat.github.io/RHP-Wiki/Confluence/MPEXIENG/Test+Infrastructure/Best+Practises/Section0.html when:
**Scenario 1: First interaction in project root**
```
AI checks for .AI_README.md → Not found
AI creates .AI_README.md using Root Directory Template
AI checks for .AI_HISTORY.md → Not found
AI creates .AI_HISTORY.md with initial entry dated today
```
**Scenario 2: Adding new feature**
```
User: "Add authentication module"
AI implements feature
AI updates .AI_HISTORY.md with entry:
- Implemented OAuth2 authentication
- Added user session management
- Required for multi-tenant support
```
**Scenario 3: Working in subdirectory with different stack**
```
AI detects subdirectory uses Python while root uses Bash
AI creates subdirectory-specific .AI_README.md with Python conventions
AI inherits .AI_HISTORY.md from root (no separate history needed yet)
```
Leave a review
No reviews yet. Be the first to review this skill!
# Download SKILL.md from killerskills.ai/api/skills/openshift-qe-context-manager/raw