Update copilot-instructions: API design rules from PR #305 review#317
Merged
jonathanpeppers merged 2 commits intomainfrom Mar 19, 2026
Merged
Update copilot-instructions: API design rules from PR #305 review#317jonathanpeppers merged 2 commits intomainfrom
jonathanpeppers merged 2 commits intomainfrom
Conversation
…loads, stdout in errors Add three rules learned from PR #305 review feedback: - Prefer strongly-typed APIs (enum+record) over string parameters - Avoid convenience overloads (string, int, typed) — pick one - Include stdout in ProcessUtils.ThrowIfFailed error diagnostics Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s Copilot guidance to capture API design patterns learned during the PR #305 review, helping keep new Android-tools APIs small, type-safe, and easier to debug.
Changes:
- Add guidance to prefer strongly-typed API parameters (record/enum) over string “spec” parameters.
- Add guidance to avoid “convenience overload” proliferation (string/int/typed variants).
- Add guidance to include stdout (when captured) in
ProcessUtils.ThrowIfFaileddiagnostics.
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
jonathanpeppers
approved these changes
Mar 19, 2026
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.
Summary
Add three rules to
.github/copilot-instructions.mdlearned from PR #305 (AdbRunnerreverse port forwarding) review feedback by @jonathanpeppers:AdbPortSpec(AdbProtocol.Tcp, 5000)) instead of raw strings like"tcp:5000"ProcessUtils.ThrowIfFailedwhen availableThese patterns keep the API surface small, type-safe, and debuggable.