applyTo: '**'
---
# GitHub Copilot Development Environment Instructions
This document provides specific guidance for GitHub Copilot when working on the .NET MAUI Samples repository. It serves as context for understanding the project
3.7k15mo agoReviewMountCreate a free account to mount
unreachableCode, deprecated)`.
- Sample `.py` files use comments like `# This should generate an error` to document expected diagnostics, but the actual assertion is the count passed to `validateResults`.
**Fourslash tests** (`src/tests/fourslash
No other project uses it yet
3.6k15mo agoReviewMountCreate a free account to mount
implementation limits.
Missing features, codec restrictions, and download limits are not permanent
exclusions. When documentation conflicts with the code, flag the stale claim
instead of using it to reject supported
3.6k51d agoReviewMountCreate a free account to mount
tasks and recurring operations
## Development Guidelines
### Coding Standards
1. Classes should use proper XML documentation
2. Follow C# naming conventions (PascalCase for public members, camelCase for private)
3. Extract interfaces
3.5k11d agoReviewMountCreate a free account to mount
protocol implementation.
- `sail-sql-*`: Sail SQL parser and analyzer.
- `sail-telemetry`: OpenTelemetry integration.
- `docs/`: Documentation site built with VitePress.
- `python/`: Source code for the `pysail` Python package.
- `scripts/`: Various scripts
3.5k8d agoReviewMountCreate a free account to mount
suppress concurrency warnings with `@preconcurrency` or `nonisolated(unsafe)` unless absolutely necessary and documented with a comment explaining why if possible.
- Prefer `async`/`await` over completion handlers for all new asynchronous
3.5k38d agoReviewMountCreate a free account to mount
Public API docs: new public structs, enums, functions, and non-obvious
members need documentation in the crate's style, and names should be
self-explanatory without abbreviations.
- Error handling
3.4k7mo agoReviewMountCreate a free account to mount
next to the code with
`[Diagnostics.CodeAnalysis.SuppressMessageAttribute('Pester.BuildAnalyzerRules\ ', ' ', Justification = '...')]`,
matching the existing suppressions in `src/`.
## Documentation
- Documentation is written in Markdown; update it when behavior changes.
- Use fenced code blocks
3.4k5y agoReviewMountCreate a free account to mount
test classes (e.g., `TestMetalake`).
- **Dependencies**: Do NOT add new dependencies without explicit user request.
- **Documentation**: JavaDoc is required for all public APIs.
## Language Specifics
- **Java**:
- Use `@Nullable` for optional fields/params
3.4k5mo agoReviewMountCreate a free account to mount
there's a strong reason to introduce breaking changes. If breaking changes are necessary, document them clearly in the relevant documentation files.
Under no circumstances should casting
Steady7 mentions in 2 weeks
No other project uses it yet
3.3k24d agoReviewMountCreate a free account to mount
format ` : `
4. **Complete checklists**: Mark appropriate items in the pre-launch checklist
5. **Document breaking changes**: Always fill in the breaking changes section if applicable
### PR Template Enforcement
- **Never create
Steady3 mentions in 2 weeks
No other project uses it yet
3.3k22mo agoReviewMountCreate a free account to mount
Actionable feedback, not observations. One sentence where one sentence does the job. On documentation or user-facing text, flag wording only when it's genuinely confusing or could mislead someone
Steady7 mentions in 2 weeks
No other project uses it yet
3.3k4mo agoReviewMountCreate a free account to mount
types
- Error handling: Use proper Swift error handling, no force unwrapping in production
- Documentation: Triple-slash comments (`///`) for public APIs
- Thread safety: Use actors, `@MainActor`, or proper locking - never `@unchecked
Steady22 mentions in 2 weeks
No other project uses it yet
3.3k13mo agoReviewMountCreate a free account to mount
affects public interfaces.
- Extremely simple changes do not require explicit unit tests.
5. Document all public APIs and non-trivial implementation details.
6. Avoid introducing new dependencies unless strictly necessary
3.3k17mo agoReviewMountCreate a free account to mount