chore: Update AI.md with instructions around tests and docs

This commit is contained in:
Anton Ovchinnikov
2025-09-29 00:02:58 +02:00
parent aebd2ac232
commit 782f4cb20b
+18 -4
View File
@@ -88,6 +88,10 @@ This document provides comprehensive information about the Uncloud project for A
- **`scripts/`**: Installation and utility scripts - **`scripts/`**: Installation and utility scripts
- **`test/`**: Test suites and test infrastructure - **`test/`**: Test suites and test infrastructure
- **`website/`**: Documentation website (Docusaurus) - **`website/`**: Documentation website (Docusaurus)
- `landing/`: Landing page
- `docs/`: User documentation
- **`misc/`**: Design documents and guides - **`misc/`**: Design documents and guides
## Key Technologies ## Key Technologies
@@ -184,9 +188,11 @@ uc context use <name> # Switch context
### Testing ### Testing
- Unit tests alongside source files (`*_test.go`) - Test files and locations
- Integration tests in `test/e2e/` - Unit tests alongside source files (`*_test.go`)
- Test fixtures in `test/fixtures/` - Integration tests in `test/e2e/`
- Test fixtures in `test/fixtures/`
- Use table driven tests whenever possible
### Dependencies ### Dependencies
@@ -233,7 +239,7 @@ uc context use <name> # Switch context
- `internal/machine/machine.go`: Core machine management - `internal/machine/machine.go`: Core machine management
- `pkg/api/`: Public API definitions - `pkg/api/`: Public API definitions
- `misc/design.md`: Architecture and design philosophy - `misc/design.md`: Architecture and design philosophy
- `README.md`: User-facing documentation - `README.md`: Repository README
### Configuration Files ### Configuration Files
@@ -242,3 +248,11 @@ uc context use <name> # Switch context
- `Dockerfile`: Container build instructions forUncloud-in-Docker (used for testing) - `Dockerfile`: Container build instructions forUncloud-in-Docker (used for testing)
This document should help AI assistants understand the project structure, make informed suggestions, and contribute effectively to the Uncloud codebase. This document should help AI assistants understand the project structure, make informed suggestions, and contribute effectively to the Uncloud codebase.
## Documentation
Instructions when generating documentation:
- Use conversational language write as if you were speaking to a friend.
- Keep sentences simple, optimize for clarity and understanding.
- Place the subject before the action whenever possible. Example: prefer “The function loads data” over “Data is loaded by the function.”