forq-cli/docs/FORQ.md.example at main · kleneway/forq-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# FORQ.md - Project-Specific Instructions

This file contains project-specific instructions and guidance for the AI when using the forq CLI tool.
Place this file in the root of your project and customize to provide context about your project.

## Project Overview

Project Name: [Your Project Name]
Description: [Brief description of what your project does]
Tech Stack: [Key technologies used]
Architecture: [Brief overview of the architecture]

## Code Style & Conventions

- [Style guide or linting preferences]
- [Naming conventions]
- [Architecture patterns to follow]
- [Testing approach]

## Key Directories

- `/src` - Source code
- `/tests` - Unit and integration tests
- `/docs` - Documentation
- `/scripts` - Build and utility scripts

## Development Workflow

- [Branch naming conventions]
- [Commit message format]
- [PR requirements]
- [CI/CD pipeline information]

## Important Notes

- [Special handling instructions]
- [Known issues or gotchas]
- [Performance considerations]
- [Security requirements]

## Acceptance Criteria

When implementing new features or fixing bugs, ensure that:
- [Criteria 1]
- [Criteria 2]
- [Criteria 3]

---

Feel free to customize this template for your specific project needs. The AI will use this information to provide more contextually relevant assistance.