chore: add Copilot instructions#3074
Conversation
Reviewer's GuideAdds a GitHub Copilot configuration document describing the project, tech stack, repo structure, coding standards, commit style, and UI guidelines to guide AI-assisted contributions and reviews. Flow diagram for repository structure documented for Copilotgraph TD
A[pslab-app root] --> B[android]
A --> C[ios]
A --> D[linux]
A --> E[macos]
A --> F[windows]
A --> G[web]
A --> H[lib]
A --> I[test]
A --> J[test_integration]
A --> K[assets]
A --> L[.github]
A --> M[scripts]
A --> N[pubspec.yaml]
subgraph LibDirectory
H --> H1[communication]
H --> H2[providers]
H --> H3[view]
H --> H4[models]
H --> H5[theme]
H --> H6[l10n]
H --> H7[others]
H --> H8[constants.dart]
H --> H9[main.dart]
end
subgraph GithubDirectory
L --> L1[workflows]
L --> L2[actions]
end
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
marcnause
force-pushed
the
add-copilot-instructions-file
branch
from
75679ea to
f3f7ff6
Compare
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Fix the typos in the commit style section (e.g., change
AdfheretoAdhereanddewscribetodescribe) to keep the instructions clear and professional. - Double-check the reference to
commitstyle.mdindocsto ensure the path and filename are correct and stable, since Copilot and contributors will rely on this pointer for commit conventions.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Fix the typos in the commit style section (e.g., change `Adfhere` to `Adhere` and `dewscribe` to `describe`) to keep the instructions clear and professional.
- Double-check the reference to `commitstyle.md` in `docs` to ensure the path and filename are correct and stable, since Copilot and contributors will rely on this pointer for commit conventions.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull request overview
This PR adds a Copilot instructions file to guide GitHub Copilot in understanding the PSLab Flutter app's architecture, conventions, and best practices. The file provides comprehensive context about the project's tech stack, repository structure, and coding standards to improve Copilot-assisted code reviews and generation.
Changes:
- Added
.github/copilot-instructions.mddocumenting project overview, tech stack (Flutter/Dart with Provider pattern and GetIt), repository structure, coding standards (Effective Dart, SOLID principles), commit style conventions, and UI guidelines.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Build StatusBuild successful. APKs to test: https://github.com/fossasia/pslab-app/actions/runs/22850221412/artifacts/5827784915. ScreenshotsAndroid Screenshots
iPhone Screenshots
iPad Screenshots
|
||||||||||||||||||||||||
-1_instruments_screen.png?raw=true)
-2_nav_drawer.png?raw=true)
-3_accelerometer.png?raw=true)
-4_power_source.png?raw=true)
-5_multimeter.png?raw=true)
-6_wave_generator.png?raw=true)
-7_oscilloscope.png?raw=true)
|
I have no idea what Codacy does not like about the document. The structure is correct, as far as I can tell. |
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider clarifying how Copilot (or other AI tools) should interpret these guidelines in case of conflicts (e.g., which takes precedence between existing code style, Dart guidelines, and SOLID/OOD principles) so automated suggestions can prioritize correctly.
- The repository structure section hardcodes specific directories and comments (e.g.,
providerscount,others/), which may drift over time; you might want to either generalize these descriptions or explicitly note that this tree is illustrative rather than authoritative.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider clarifying how Copilot (or other AI tools) should interpret these guidelines in case of conflicts (e.g., which takes precedence between existing code style, Dart guidelines, and SOLID/OOD principles) so automated suggestions can prioritize correctly.
- The repository structure section hardcodes specific directories and comments (e.g., `providers` count, `others/`), which may drift over time; you might want to either generalize these descriptions or explicitly note that this tree is illustrative rather than authoritative.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
marcnause
force-pushed
the
add-copilot-instructions-file
branch
from
fbf9b17 to
4102f00
Compare
Removed a blank line at the beginning of the file.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```text | ||
| pslab-app/ | ||
| ├── android/ # Android-specific platform code | ||
| ├── ios/ # iOS-specific platform code |
There was a problem hiding this comment.
There are trailing spaces at the end of this line (after "code"). In Markdown this can create an unintended hard line break and also adds noise to diffs; please remove the trailing whitespace.
| ├── ios/ # iOS-specific platform code | |
| ├── ios/ # iOS-specific platform code |
| │ ├── constants.dart # App-wide constants | ||
| │ └── main.dart # App entry point | ||
| ├── test/ # Unit tests | ||
| ├── test_integration/# Integration tests |
There was a problem hiding this comment.
The repository tree entry for test_integration/ is missing spacing before the inline comment (test_integration/# ...), which is inconsistent with the other entries and renders oddly. Consider aligning it as test_integration/ # Integration tests.
| ├── test_integration/# Integration tests | |
| ├── test_integration/ # Integration tests |
Fixes: #3073
I hope this PR will have a positive effect on Copilot code reviews.
Summary by Sourcery
Add GitHub Copilot guidance for this repository to improve AI-assisted code reviews and contributions.
Documentation:
Summary by Sourcery
Add repository-level GitHub Copilot guidance to align AI-assisted contributions with the project’s architecture and standards.
Documentation: