Conversation
Co-authored-by: RemeJuan <864552+RemeJuan@users.noreply.github.com>
Co-authored-by: RemeJuan <864552+RemeJuan@users.noreply.github.com>
|
@copilot firewall rules updated, please try again |
Co-authored-by: RemeJuan <864552+RemeJuan@users.noreply.github.com>
I've now accessed the official best practices documentation and updated the Copilot instructions accordingly. The file has been restructured to follow the recommended format with:
Changes made in commit |
There was a problem hiding this comment.
Pull request overview
Adds repository-specific GitHub Copilot coding agent instructions to help generated code follow this Flutter/Riverpod/Firebase project’s workflows, tooling, and conventions.
Changes:
- Added
.github/copilot-instructions.mddocumenting local dev workflow (FVM, Make targets, lefthook hooks). - Documented linting/code-quality rules and
dart_code_metricsthresholds derived fromanalysis_options.yaml. - Documented code generation, testing/coverage, and project structure/localization/Firebase notes.
| 5. **Testing**: Write tests for new features; maintain or improve coverage | ||
| 6. **Localization**: Ensure all user-facing strings are localizable (30+ languages supported) | ||
| 7. **iOS Only**: This app requires iOS with HealthKit access |
There was a problem hiding this comment.
The parenthetical "(30+ languages supported)" is currently inaccurate; the generated localization delegate lists 29 supported locales. Please update or rephrase to avoid drifting from the actual locale list.
| - **Framework**: Flutter 3.8.0+ | ||
| - **Language**: Dart |
There was a problem hiding this comment.
The stated Flutter version (3.8.0+) looks incorrect for this repo. .fvmrc pins Flutter to 3.35.1, while pubspec.yaml sets the Dart SDK constraint to ">=3.8.0 <4.0.0". Please update this section to reflect the pinned Flutter version and (if desired) separately document the Dart SDK constraint.
| - **Framework**: Flutter 3.8.0+ | |
| - **Language**: Dart | |
| - **Framework**: Flutter 3.35.1 (pinned via FVM) | |
| - **Language**: Dart (SDK constraint: >=3.8.0 <4.0.0) |
| - **Code Generation**: freezed, json_serializable, build_runner | ||
| - **Analytics & Crash Reporting**: Firebase Analytics, Firebase Crashlytics | ||
| - **Health Data**: Apple Health integration via `health` package | ||
| - **Localization**: flutter_localizations with localizely_sdk (30+ languages) |
There was a problem hiding this comment.
The repo currently supports 29 locales (see lib/generated/l10n.dart -> supportedLocales), so describing localization as "30+ languages" is inaccurate. Please update the count or rephrase (e.g., "~30 languages" or "29 languages").
| - **Localization**: flutter_localizations with localizely_sdk (30+ languages) | |
| - **Localization**: flutter_localizations with localizely_sdk (29 languages) |
| ## Required Before Each Commit | ||
|
|
||
| - Run `fvm flutter analyze` to ensure code meets linting standards | ||
| - Run `make flutter_test` to ensure all tests pass (enforced by pre-push git hook) |
There was a problem hiding this comment.
This section title says "Required Before Each Commit", but the text indicates enforcement happens via a pre-push hook (and only for tests). Consider renaming this section (e.g., "Before pushing") or rewording the bullets to avoid implying these checks are enforced at commit time.
| ## Required Before Each Commit | |
| - Run `fvm flutter analyze` to ensure code meets linting standards | |
| - Run `make flutter_test` to ensure all tests pass (enforced by pre-push git hook) | |
| ## Before Pushing | |
| - Run `fvm flutter analyze` to ensure code meets linting standards | |
| - Run `make flutter_test` to ensure all tests pass (tests are enforced by the pre-push git hook) |
|
|
||
| ## Localization | ||
|
|
||
| - Supports 30+ languages via localizely_sdk |
There was a problem hiding this comment.
This repeats the "30+ languages" claim, but the generated localization delegate currently lists 29 supported locales. Please keep the localization count consistent and accurate across the document.
| - Supports 30+ languages via localizely_sdk | |
| - Supports 29 languages via localizely_sdk |
Configures GitHub Copilot coding agent with repository-specific context and conventions following official best practices from https://gh.io/copilot-coding-agent-tips.
Changes
Added
.github/copilot-instructions.mdfollowing GitHub's recommended format with:analysis_options.yaml, code quality metrics (cyclomatic complexity: 20, max nesting: 5, max parameters: 4, source lines: 50)core/,models/,pages/,providers/,widgets/, generated code exclusionsThe instructions are structured following GitHub's official best practices format, emphasizing required pre-commit steps and clear development workflow to help Copilot generate code that follows project conventions and understands the Flutter/Dart/Riverpod architecture patterns used throughout the codebase.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.