Add .github/copilot-instructions.md#744
Add .github/copilot-instructions.md#744jerrysxie wants to merge 2 commits intoOpenDevicePartnership:mainfrom
Conversation
Add Copilot instructions covering build/test/lint commands, service architecture patterns, and key codebase conventions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jerrysxie
requested review from
RobertZ2011,
felipebalbi,
tullom and
williampMSFT
There was a problem hiding this comment.
Pull request overview
Adds a new .github/copilot-instructions.md document intended to guide Copilot (and contributors) on how to build/test/lint the workspace and on key architecture/convention details for the embedded-services codebase.
Changes:
- Introduces a Copilot instruction doc with common build/lint/test commands aligned to CI workflows.
- Documents service/IPC architecture concepts (comms endpoints, message routing) and core utilities/macros.
- Captures conventions around feature flags, clippy strictness, dependencies, and testing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kurtjd
left a comment
kurtjd
left a comment
There was a problem hiding this comment.
I'll be honest I'm still not entirely sure what these instructions offer if they are AI generated in the first place (I thought things like skills, AGENTS.md, CLAUDE.md, etc are to provide additional context the LLM can't glean on it's own from the codebase) but that likely means I just need to research this a bit more.
@kurtjd It is more like breadcrumbs to help the agent to find its way. Unless we commit something to AI agent's memory, it will need to rediscover the context every single time when we open a new session. Instruction file helps AI to find its way faster. We can also add contributing policy to the instruction file so agent would follow our guidelines. |
Okay that makes sense to me. Yeah I suppose we just need to be careful since embedded-services patterns and architecture are changing pretty frequently and don't want this to drift too far from the actual state of the repo. Maybe a rolling workflow can have Copilot regenerate this every so often or just have a rule that PRs introducing significant changes need to update this as well. |
Replace outdated comms-based service pattern with the Service<'hw> trait, Resources, and Runner pattern from v0.2.0 branch. Add note that main branch still has legacy patterns being phased out. Changes: - Rewrite service pattern to show Service trait, Runner, Resources, and spawn_service! macro - Add API guidelines reference and key principles - Replace comms IPC section with current mechanisms - Add relay pattern to IPC list - Add examples/rt633 to build/lint commands - Fix GlobalRawMutex to include RISC-V target - Soften error handling to 'prefer' language - Document both block_on and tokio::test patterns - Add commit message guidelines section - Remove deprecated comms, intrusive_list, static buffer references from core utilities Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add Copilot instructions covering build/test/lint commands, service architecture patterns, and key codebase conventions.