MS-1291 Add baseline copilot instructions in SID#1524
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds baseline GitHub Copilot instructions to guide AI-assisted development in the Simprints ID (SID) project. The instructions document coding standards, architecture patterns, dependency injection practices, and testing conventions specific to the Android Kotlin codebase.
Changes:
- Added comprehensive Copilot instructions covering code style, Android architecture, layered module design, dependency injection with Dagger Hilt, and unit testing practices
- Removed unused dependency from orchestrator-data module
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
.github/copilot-instructions.md |
New file defining project-specific guidelines for GitHub Copilot, covering Kotlin style, Android architecture patterns, module structure, DI with Hilt, and testing conventions |
infra/orchestrator-data/build.gradle.kts |
Removed :feature:exit-form dependency (architecturally correct but unrelated to main PR purpose) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
a4d7dd6 to
838f672
Compare
|
| 2. Android Architecture: | ||
|
|
||
| * Android Jetpack ViewModel is used for managing UI-related data. | ||
| * ViewModels are lifecycle-aware and use viewModelScope for coroutines. |
There was a problem hiding this comment.
Maybe add that a dedicated @SessionCoroutineScope is used to manage events
There was a problem hiding this comment.
I am not convinced that CoPilot will be able to grasp the concept of "events" without a long explicit explanation.
There was a problem hiding this comment.
Not necessarily long and explicit. "The app uses custom event system where at certain key workflow points events are generated, saved through a dedicated @SessionCoroutineScope and then periodically upsynced through a dedicated worker"
There was a problem hiding this comment.
Without prior knowledge, I would assume that "custom event system" is some sort of an event queue/bus, so this would need to be a bit longer.
My goal was to start with fairly "generic" context that lists things that AI models might have already scraped from the internet. We probably should add some detailed SID-specific concept explanations later.



JIRA ticket
Notable changes
Additional work checklist