AIPROMPT

# AIPROMPT.md

This project supports AI-assisted development.

This file serves as a system prompt for language models (e.g., ChatGPT, GitHub Copilot, Cody) to work contextually with the codebase. It provides essential information about the library and links to task-specific prompts stored in the [`ai/`](./ai/) directory.

---

## Project Overview

- **Name:** MyLibrary
- **Type:** PHP Composer Library
- **Purpose:** [Brief summary of what the library does]
- **Structure:**  
  - `src/` – main source code  
  - `tests/` – test suite  
  - `composer.json` – metadata and dependencies

---

## AI Development Context

This file enables AI tools to assist effectively in developing, extending, and understanding this codebase. You are encouraged to use it as a starting point for:

- Code explanations
- Bug analysis
- Test writing
- Feature planning
- Style and security reviews

Please refer to the categorized prompt templates in the `ai/` folder for deeper guidance.

---

## Available AI Prompts

| Topic          | File                            |
|----------------|---------------------------------|
| Debugging      | [`ai/debug.md`](./ai/debug.md)               |
| Feature Ideas  | [`ai/features.md`](./ai/features.md)         |
| Refactoring    | [`ai/refactoring.md`](./ai/refactoring.md)   |
| Testing        | [`ai/testing.md`](./ai/testing.md)           |
| Code Explanation | [`ai/explain.md`](./ai/explain.md)         |
| Library Usage  | [`ai/usage.md`](./ai/usage.md)               |
| Glossary       | [`ai/glossary.md`](./ai/glossary.md)         |
| Migration      | [`ai/migration.md`](./ai/migration.md)       |
| Security       | [`ai/security.md`](./ai/security.md)         |
| Style Guide    | [`ai/styleguide.md`](./ai/styleguide.md)     |
| Prompt Library | [`ai/prompts.json`](./ai/prompts.json)       |

---

## System Prompt for AI Models

> You are an AI development assistant working with a modern PHP Composer library.  
> 
> Base your understanding on:
> - `composer.json` (project metadata)
> - `README.md` (general documentation)
> - `src/` (implementation code)
> - `tests/` (unit/integration tests)
>
> You may reference task-specific prompts in the [`ai/`](./ai/) directory.  
> Focus on clarity, valid PHP code, and adherence to project conventions.  
> Always explain your reasoning when proposing changes.

---

## Contribution

If you enhance, add, or fine-tune AI prompts, please update this file accordingly. Prompts are part of this codebase's development interface.