Skip to content

✨ Set up Copilot instructions#7

Merged
RemeJuan merged 4 commits intomainfrom
copilot/setup-copilot-instructions
Feb 10, 2026
Merged

✨ Set up Copilot instructions#7
RemeJuan merged 4 commits intomainfrom
copilot/setup-copilot-instructions

Conversation

Copy link
Contributor

Copilot AI commented Feb 9, 2026

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.md following GitHub's recommended format with:

  • Clear project description: Flutter app for Apple Health calorie tracking with context upfront
  • Required pre-commit steps: Highlighted analyze, test, and code generation requirements
  • Development flow: Quick reference for Make commands and FVM-prefixed Flutter commands
  • Tech stack context: Flutter 3.8.0+, Riverpod state management, freezed/json_serializable code generation, Firebase integration, FVM version management
  • Code standards: Numbered list of Dart/Flutter conventions from analysis_options.yaml, code quality metrics (cyclomatic complexity: 20, max nesting: 5, max parameters: 4, source lines: 50)
  • Key guidelines: Critical conventions for FVM usage, state management, testing, and localization
  • Project structure: Directory organization with core/, models/, pages/, providers/, widgets/, generated code exclusions
  • Platform specifics: iOS-only Apple Health integration, 30+ language localization via localizely_sdk

The 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

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits February 9, 2026 13:18
Co-authored-by: RemeJuan <864552+RemeJuan@users.noreply.github.com>
Co-authored-by: RemeJuan <864552+RemeJuan@users.noreply.github.com>
Copilot AI changed the title [WIP] Set up Copilot instructions for repository Add Copilot instructions for repository Feb 9, 2026
Copilot AI requested a review from RemeJuan February 9, 2026 13:19
@RemeJuan
Copy link
Owner

@copilot firewall rules updated, please try again

Co-authored-by: RemeJuan <864552+RemeJuan@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 10, 2026

@copilot firewall rules updated, please try again

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:

  • Clear project description upfront
  • "Required Before Each Commit" section (analyze, test, code generation)
  • Streamlined "Development Flow" section
  • More concise organization throughout
  • Numbered conventions list for easier reference

Changes made in commit 71d94cd.

Copilot AI changed the title Add Copilot instructions for repository ✨ Set up Copilot instructions Feb 10, 2026
@RemeJuan RemeJuan marked this pull request as ready for review February 10, 2026 13:56
Copilot AI review requested due to automatic review settings February 10, 2026 13:56
@RemeJuan RemeJuan merged commit 3da2b27 into main Feb 10, 2026
3 of 4 checks passed
@RemeJuan RemeJuan deleted the copilot/setup-copilot-instructions branch February 10, 2026 13:56
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md documenting local dev workflow (FVM, Make targets, lefthook hooks).
  • Documented linting/code-quality rules and dart_code_metrics thresholds derived from analysis_options.yaml.
  • Documented code generation, testing/coverage, and project structure/localization/Firebase notes.

Comment on lines +70 to +72
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
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines +23 to +24
- **Framework**: Flutter 3.8.0+
- **Language**: Dart
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- **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)

Copilot uses AI. Check for mistakes.
- **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)
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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").

Suggested change
- **Localization**: flutter_localizations with localizely_sdk (30+ languages)
- **Localization**: flutter_localizations with localizely_sdk (29 languages)

Copilot uses AI. Check for mistakes.
Comment on lines +7 to +10
## 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)
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
## 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)

Copilot uses AI. Check for mistakes.

## Localization

- Supports 30+ languages via localizely_sdk
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- Supports 30+ languages via localizely_sdk
- Supports 29 languages via localizely_sdk

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants