docs(architecture): update AI assistant documentation and project structure
Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
This commit is contained in:
34
README.md
34
README.md
@@ -49,11 +49,37 @@ Configuration files can be found in the `config/` directory.
|
||||
├── go.mod # Go module definition
|
||||
├── go.sum # Go module checksums
|
||||
├── README.md # This file
|
||||
└── QWEN.md # Qwen Code context file
|
||||
├── .claude/ # Claude Code specific configuration and tools
|
||||
├── .gemini/ # Gemini specific configuration and tools
|
||||
├── .opencode/ # OpenCode specific configuration and tools
|
||||
├── .qwen/ # Qwen Code specific configuration and tools
|
||||
├── CLAUDE.md # Complete project documentation and Claude context (comprehensive example)
|
||||
├── GEMINI.md # Gemini context (simplified, references CLAUDE.md)
|
||||
├── OPENCODE.md # OpenCode context (simplified, references CLAUDE.md)
|
||||
└── QWEN.md # Qwen Code context (simplified, references CLAUDE.md)
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
### AI Assistant CLI Configurations
|
||||
|
||||
This project is configured to work with multiple AI coding assistants, each with specialized expertise:
|
||||
|
||||
- **Claude** (`.claude/`) - System architecture, design patterns, and integration
|
||||
- **OpenCode** (`.opencode/`) - Multi-language development and testing
|
||||
- **Qwen Code** (`.qwen/`) - Mathematical computations and precision handling
|
||||
- **Gemini** (`.gemini/`) - Performance optimization and concurrency
|
||||
|
||||
### Git Workflow
|
||||
|
||||
This project follows a comprehensive Git workflow with specific branch strategies, commit conventions, and automated checks. See [docs/GIT_WORKFLOW.md](docs/GIT_WORKFLOW.md) and [docs/BRANCH_STRATEGY.md](docs/BRANCH_STRATEGY.md) for detailed information.
|
||||
|
||||
Key aspects:
|
||||
- **Branch Strategy**: `main`, `develop`, `feature/*`, `fix/*`, `release/*`, `hotfix/*`
|
||||
- **Commit Messages**: Conventional commits format
|
||||
- **Git Hooks**: Pre-commit and pre-push checks
|
||||
- **Pull Requests**: Required for all merges to `main` and `develop`
|
||||
|
||||
### Prompts Directory
|
||||
|
||||
The `@prompts/` directory contains prompts that can be used with AI coding assistants for various development tasks.
|
||||
@@ -61,10 +87,10 @@ The `@prompts/` directory contains prompts that can be used with AI coding assis
|
||||
### Contributing
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch
|
||||
3. Commit your changes
|
||||
2. Create a feature branch following the branch naming conventions
|
||||
3. Commit your changes with conventional commit messages
|
||||
4. Push to the branch
|
||||
5. Create a Pull Request
|
||||
5. Create a Pull Request with detailed description
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user