windy/go-caatsm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

✨ Introduce GEMINI project documentation and enhance AGENTS.md

Browse Source 
This commit adds comprehensive documentation for the new GEMINI project, detailing its architecture, tech stack, key commands, and development workflow. The documentation emphasizes the Clean Architecture principles and modular design of the application.

Additionally, AGENTS.md is updated to include information about the composite parser pattern and core domain types related to aviation telegrams and weather reports, enhancing clarity on the project's structure and design choices.

New Files:
- GEMINI.md: Detailed project overview and architecture documentation.

Updates:
- AGENTS.md: Added sections on parsers and core domain types.

These changes aim to improve onboarding and understanding of the project's architecture and functionality.
This commit is contained in:
windyboy
2025-12-27 12:20:06 +08:00
parent c0a66cf845
commit c398e51779
13 changed files with 542 additions and 1344 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+2
View File
@@ -10,6 +10,8 @@
## Code Style & Architecture
- **Structure**: Clean Architecture (`cmd/`, `internal/{domain,app,adapter,infra}`, `pkg/`).
- **Parsers**: Composite parser pattern with specialized sub-parsers (aviation, weather).
- **Domain**: Core domain types include aviation telegrams and weather reports.
- **Formatting**: Run `go fmt ./...` and `goimports` before committing.
- **Naming**: `CamelCase` (exported), `camelCase` (private). Package names match dirs.
- **Errors**: Wrap with context (`fmt.Errorf("...: %w", err)`). Use `errors.Is`.