Skip to content

MS-1291 Add baseline copilot instructions in SID#1524

Merged
luhmirin-s merged 2 commits into
mainfrom
feature/general-ai-context
Jan 12, 2026
Merged

MS-1291 Add baseline copilot instructions in SID#1524
luhmirin-s merged 2 commits into
mainfrom
feature/general-ai-context

Conversation

@luhmirin-s
Copy link
Copy Markdown
Contributor

JIRA ticket

Notable changes

  • Added common CoPilot instructions file

Additional work checklist

  • Effect on other features and security has been considered
  • Design document marked as "In development" (if applicable)
  • External (Gitbook) and internal (Confluence) Documentation is up to date (or ticket created)
  • Test cases in Testiny are up to date (or ticket created)
  • Other teams notified about the changes (if applicable)

@luhmirin-s luhmirin-s requested review from a team, BurningAXE, TristramN, alex-vt, alexandr-simprints, meladRaouf and ybourgery and removed request for a team January 12, 2026 09:48
@cla-bot cla-bot Bot added the ... label Jan 12, 2026
Comment thread .github/copilot-instructions.md
@luhmirin-s luhmirin-s marked this pull request as ready for review January 12, 2026 12:18
@luhmirin-s luhmirin-s requested a review from Copilot January 12, 2026 12:18
Copy link
Copy Markdown

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

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.

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md
Comment thread .github/copilot-instructions.md
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md
Comment thread infra/orchestrator-data/build.gradle.kts
@luhmirin-s luhmirin-s force-pushed the feature/general-ai-context branch from a4d7dd6 to 838f672 Compare January 12, 2026 12:27
@sonarqubecloud
Copy link
Copy Markdown

Comment thread .github/copilot-instructions.md
Comment thread .github/copilot-instructions.md Outdated
2. Android Architecture:

* Android Jetpack ViewModel is used for managing UI-related data.
* ViewModels are lifecycle-aware and use viewModelScope for coroutines.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe add that a dedicated @SessionCoroutineScope is used to manage events

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I am not convinced that CoPilot will be able to grasp the concept of "events" without a long explicit explanation.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

@luhmirin-s luhmirin-s merged commit 7d7b607 into main Jan 12, 2026
13 checks passed
@luhmirin-s luhmirin-s deleted the feature/general-ai-context branch January 12, 2026 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants