Skip to content

Commit e4516c8

Browse files
authored
Merge pull request #77 from github/edburns/dd-2853206-reference-impl-not-upstream
Replace ambiguous upstream terminology with reference implementation wording
2 parents db56504 + 03cfc35 commit e4516c8

26 files changed

+412
-399
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: agentic-merge-reference-impl
3+
description: Merge reference implementation changes from the official Copilot SDK into this Java SDK.
4+
license: MIT
5+
---
6+
7+
Follow instructions in the [agentic-merge-reference-impl prompt](../../../.github/prompts/agentic-merge-reference-impl.prompt.md) to merge reference implementation changes from the official Copilot SDK into this Java SDK.

.claude/skills/agentic-merge-upstream/SKILL.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

.github/copilot-instructions.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ These instructions guide GitHub Copilot when assisting with this repository. The
99
- **Tech Stack**: Java 17+, Maven, Jackson for JSON, JUnit for testing
1010
- **Purpose**: Provide a Java SDK for programmatic control of GitHub Copilot CLI
1111
- **Architecture**: JSON-RPC client communicating with Copilot CLI over stdio
12-
- **Key Goals**: Maintain parity with upstream .NET SDK while following Java idioms
12+
- **Key Goals**: Maintain parity with reference implementation .NET SDK while following Java idioms
1313

1414
## Build & Test Commands
1515

@@ -85,13 +85,13 @@ Tests use the official copilot-sdk test harness from `https://github.com/github/
8585

8686
- **E2ETestContext** - Manages test environment with CapiProxy for deterministic API responses
8787
- **CapiProxy** - Node.js-based replaying proxy using YAML snapshots from `test/snapshots/`
88-
- Test snapshots are stored in the upstream repo's `test/snapshots/` directory
88+
- Test snapshots are stored in the reference implementation repo's `test/snapshots/` directory
8989

9090
## Key Conventions
9191

92-
### Upstream Merging
92+
### Reference Implementation Merging
9393

94-
This SDK tracks the official .NET implementation at `github/copilot-sdk`. The `.lastmerge` file contains the last merged upstream commit hash. Use the `agentic-merge-upstream` skill (see `.github/prompts/agentic-merge-upstream.prompt.md`) to port changes.
94+
This SDK tracks the official .NET implementation at `github/copilot-sdk`. The `.lastmerge` file contains the last merged reference implementation commit hash. Use the `agentic-merge-reference-impl` skill (see `.github/prompts/agentic-merge-reference-impl.prompt.md`) to port changes.
9595

9696
When porting from .NET:
9797
- Adapt to Java idioms, don't copy C# patterns directly
@@ -217,7 +217,7 @@ Test method names are converted to lowercase snake_case for snapshot filenames t
217217
- **DO NOT** modify `target/` directory - this contains build artifacts
218218
- **DO NOT** edit `pom.xml` dependencies without careful consideration - this SDK has minimal dependencies by design
219219
- **DO NOT** change the Jackson version without testing against all serialization patterns
220-
- **DO NOT** modify test snapshots in `target/copilot-sdk/test/snapshots/` - these come from upstream
220+
- **DO NOT** modify test snapshots in `target/copilot-sdk/test/snapshots/` - these come from reference implementation
221221
- **DO NOT** alter the Eclipse formatter configuration in `pom.xml` without team consensus
222222
- **DO NOT** remove or skip Checkstyle or Spotless checks
223223

@@ -278,7 +278,7 @@ The repository has a pre-commit hook (`.githooks/pre-commit`) that is **automati
278278
- Include tests for new functionality
279279
- Update documentation if adding/changing public APIs
280280
- Reference related issues using `#issue-number`
281-
- For upstream merges, follow the `agentic-merge-upstream` skill workflow
281+
- For reference implementation merges, follow the `agentic-merge-reference-impl` skill workflow
282282

283283
## Development Workflow
284284

@@ -299,12 +299,12 @@ The release process is automated via the `publish-maven.yml` GitHub Actions work
299299
- Converts the `## [Unreleased]` section to `## [version] - date`
300300
- Creates a new empty `## [Unreleased]` section at the top
301301
- Updates version comparison links at the bottom of CHANGELOG.md
302-
- Injects the upstream SDK commit hash (from `.lastmerge`) as a `> **Upstream sync:**` blockquote in both the new `[Unreleased]` section and the released version section
302+
- Injects the reference implementation SDK commit hash (from `.lastmerge`) as a `> **Reference implementation sync:**` blockquote in both the new `[Unreleased]` section and the released version section
303303

304-
2. **Upstream Sync Tracking**: Each release records which commit from the official `github/copilot-sdk` it is synced to:
304+
2. **Reference Implementation Sync Tracking**: Each release records which commit from the official `github/copilot-sdk` it is synced to:
305305
- The `.lastmerge` file is read during the release workflow
306306
- The commit hash is injected into `CHANGELOG.md` under the release heading
307-
- Format: `> **Upstream sync:** [\`github/copilot-sdk@SHORT_HASH\`](link-to-commit)`
307+
- Format: `> **Reference implementation sync:** [\`github/copilot-sdk@SHORT_HASH\`](link-to-commit)`
308308

309309
3. **Documentation Updates**: README.md and jbang-example.java are updated with the new version.
310310

@@ -316,3 +316,4 @@ The release process is automated via the `publish-maven.yml` GitHub Actions work
316316
5. **Rollback**: If the release fails, the documentation commit is automatically reverted
317317

318318
The workflow is triggered manually via workflow_dispatch with optional version parameters.
319+

0 commit comments

Comments
 (0)