fossasiafossasia/pslab-app/.github/copilot-instructions.md

pslab-app

Copilot instructions2.1k starsChanged 11 months agoApache-2.0View on GitHub

PSLab App is a Flutter cross-platform application for performing scientific experiments with the Pocket Science Lab (PSLab) open-hardware platform. It provides instruments like oscilloscope, multimeter, wave generator, logic analyzer, and various sensor interfaces. - Adhere to the commit style described in the file commitstyle.md in the docs folder of this project. - The UI of the app must be consistent - The UI of the app should adhere to the best practices for adaptive design described in <https://docs.flutter.dev/ui/adaptive-responsive/best-practices>.

Oct 28, 2026Push workflow fails: oversized artifacts cannot be pushed to `app` branch — fossasia/magic-epaper-app0 reactions
Oct 27, 2026CI push workflow fails because fastlane is not installed on runner — fossasia/badgemagic-app0 reactions
Aug 3, 2026UART comunication problem — fossasia/pslab-firmware0 reactions
Jul 7, 2026iOS: add UIScene lifecycle support — fossasia/badgemagic-app0 reactions
Jul 7, 2026iOS: add UIScene lifecycle support — fossasia/magic-epaper-app0 reactions

5 more on GitHub

Jul 6, 2026Creation of screenshots fails in CI for iOS devices — fossasia/magic-epaper-app0 reactions
Jul 6, 2026Creation of screenshots fails in CI for iOS devices — fossasia/badgemagic-app0 reactions
May 18, 2026README references outdated desktop application — fossasia/pslab-python0 reactions
May 3, 2026Push workflow run does not work for iOS anymore — fossasia/badgemagic-app0 reactions · 1 comment
Jan 29, 2026Docs: Update repository Urls to point to new pslab-app location — Soorajr005/pslab-app0 reactions

Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.
Of the Copilot instructions files we read, the 2,336 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

The file

We split this copilot-instructions.md into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Keep in mind the architecture recommendations described in <https://docs.flutter.dev/app-architecture/guide>.
line 51

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

copilot-instructions.md

Project Overview

PSLab App is a Flutter cross-platform application for performing scientific experiments with the Pocket Science Lab (PSLab) open-hardware platform. It provides instruments like oscilloscope, multimeter, wave generator, logic analyzer, and various sensor interfaces.

Tech Stack

Framework: Flutter (stable channel)
Language: Dart
State Management: Provider pattern
Dependency Injection: GetIt (service locator pattern)
Supported Platforms: Android (primary), iOS, Linux, macOS, Windows, Web

Repository Structure

pslab-app/
├── android/          # Android-specific platform code
├── ios/              # iOS-specific platform code  
├── linux/            # Linux-specific platform code
├── macos/            # macOS-specific platform code
├── windows/          # Windows-specific platform code
├── web/              # Web-specific platform code
├── lib/              # Code shared by all platforms
│   ├── communication/    # Hardware communication layer (USB, sensors, peripherals)
│   ├── providers/        # State management (Provider pattern, ~32 files)
│   ├── view/            # UI screens and widgets
│   ├── models/          # Data models
│   ├── theme/           # App theming and colors
│   ├── l10n/            # Localization (i18n) files
│   ├── others/          # Utilities and helpers
│   ├── constants.dart   # App-wide constants
│   └── main.dart        # App entry point
├── test/            # Unit tests
├── test_integration/# Integration tests
├── assets/          # Images, icons, and other assets
├── .github/
│   ├── workflows/   # CI/CD workflows
│   └── actions/     # Reusable GitHub Actions
├── scripts/         # Build and deployment scripts
└── pubspec.yaml     # Dependencies and project configuration

Coding Standards

Adhere to the coding style described in https://dart.dev/effective-dart/style.
Adhere to the SOLID design principles described in https://simple.wikipedia.org/wiki/SOLID_(object-oriented_design).
Adhere to Object-Oriented Design best practices described in http://butunclebob.com/ArticleS.UncleBob.PrinciplesOfOod.
Keep in mind the architecture recommendations described in https://docs.flutter.dev/app-architecture/guide.

Commit Style

Adhere to the commit style described in the file commitstyle.md in the docs folder of this project.

UI guidelines

The UI of the app must be consistent
The UI of the app should adhere to the best practices for adaptive design described in https://docs.flutter.dev/ui/adaptive-responsive/best-practices.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free