mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
4b193ecb0d
* Initial plan * Add copilot-instructions.md and .cursorrules for AI agents Co-authored-by: tig <585482+tig@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: tig <585482+tig@users.noreply.github.com>
49 lines
1.8 KiB
Plaintext
49 lines
1.8 KiB
Plaintext
# Terminal.Gui - Cursor AI Rules
|
|
|
|
This project uses comprehensive AI agent instructions. See:
|
|
- `.github/copilot-instructions.md` - Complete onboarding guide (primary reference)
|
|
- `AGENTS.md` - General AI agent guidelines
|
|
|
|
## Quick Reference
|
|
|
|
### Project Type
|
|
- .NET 8.0 cross-platform console UI toolkit
|
|
- 496 source files in core library
|
|
- GitFlow branching (v2_develop = default)
|
|
|
|
### Essential Commands
|
|
|
|
```bash
|
|
# Always run from repo root in this order:
|
|
dotnet restore # First! (~15-20s)
|
|
dotnet build --configuration Debug --no-restore # ~50s, expect ~326 warnings
|
|
dotnet test Tests/UnitTestsParallelizable --no-build # Preferred test suite
|
|
dotnet run --project Examples/UICatalog/UICatalog.csproj # Demo app
|
|
```
|
|
|
|
### Code Style (Enforced)
|
|
- **DO**: Use explicit types (avoid `var`), target-typed `new()`, 4-space indent
|
|
- **DO**: Format only files you modify (ReSharper/Rider `Ctrl-E-C` or `Ctrl-K-D`)
|
|
- **DO**: Follow `.editorconfig` and `Terminal.sln.DotSettings`
|
|
- **DON'T**: Add new linters, modify unrelated code, decrease test coverage
|
|
|
|
### Testing Rules
|
|
- Add new tests to `Tests/UnitTestsParallelizable/` (preferred)
|
|
- Avoid `Application.Init` and static dependencies in tests
|
|
- Don't use `[AutoInitShutdown]` attribute (legacy)
|
|
- Maintain 70%+ code coverage on new code
|
|
|
|
### API Documentation (Required)
|
|
- All public APIs need XML docs (`<summary>`, `<remarks>`, `<example>`)
|
|
- Use `<see cref=""/>` for cross-references
|
|
- Complex topics → `docfx/docs/*.md`
|
|
|
|
### Common Issues
|
|
- ~326 build warnings are normal (nullable refs, etc.)
|
|
- Tests can take 5-10 minutes
|
|
- Run `dotnet restore` before any build
|
|
- Read `.github/copilot-instructions.md` for full troubleshooting
|
|
|
|
---
|
|
**See `.github/copilot-instructions.md` for complete instructions**
|