pole-instrument Technical Design - #7
Closed
chuntaojun wants to merge 1 commit into
Closed
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a proposed technical design (ADR) for the future pole-instrument launcher, makes it discoverable from existing repo docs, and introduces a test that asserts the design document contains key contract phrases.
Changes:
- Add
context-kg/technical/adr/pole-instrument.mddescribing packaging boundaries, activation contract, failure policy, process model, configuration, and verification requirements. - Update docs/indexing so the new ADR is discoverable (
README.md,context-kg/_meta/index.md). - Add
tests/test_pole_instrument_design.pyto enforce presence of specific design requirements in the ADR.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tests/test_pole_instrument_design.py | Adds unittest assertions to keep the pole-instrument ADR content aligned with acceptance criteria phrases. |
| README.md | Links to the proposed pole-instrument technical design ADR and clarifies it is not yet approved/implemented. |
| context-kg/technical/adr/pole-instrument.md | Introduces the proposed pole-instrument launcher technical design ADR. |
| context-kg/_meta/index.md | Updates KG index date and adds a link entry for the new pole-instrument ADR. |
Suppressed comments (1)
tests/test_pole_instrument_design.py:22
Path.read_text()defaults to the process locale encoding; sinceREADME.mdandcontext-kg/_meta/index.mdcontain non-ASCII text, these reads can fail on systems where the locale isn’t UTF-8 (and make the test flaky). Specifyencoding="utf-8"consistently like the DESIGN read.
self.assertIn("[[pole-instrument]]", (ROOT / "context-kg" / "_meta" / "index.md").read_text())
self.assertIn("pole-instrument", (ROOT / "README.md").read_text())
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+1
to
+6
| import unittest | ||
| from pathlib import Path | ||
|
|
||
|
|
||
| ROOT = Path(__file__).resolve().parents[1] | ||
| DESIGN = ROOT / "context-kg" / "technical" / "adr" / "pole-instrument.md" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated delivery created by Dalqen.
Task:
task-f2f5ee92d66a20a7