Add comprehensive GitHub Copilot instructions for firebase-kotlin-sdk#808
Merged
Add comprehensive GitHub Copilot instructions for firebase-kotlin-sdk#808
Conversation
Added comprehensive instructions for using GitHub Copilot with the firebase-kotlin-sdk project, covering project overview, architecture, design principles, serialization, API compatibility, platform-specific notes, documentation, code style, binary API validation, testing, and guidelines for Copilot usage.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds repository-specific GitHub Copilot guidance for the firebase-kotlin-sdk to steer generated changes toward the project’s Kotlin-first, multiplatform architecture and API-compatibility goals.
Changes:
- Introduces a new
.github/copilot-instructions.mdwith architecture, API, serialization, style, and testing guidance for contributors/Copilot. - Documents Kotlin-first design principles (suspending APIs, Flow usage, default args over builders) and binary API validation expectations.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
.github/copilot-instructions.md
Outdated
Comment on lines
+24
to
+26
| commonTest/ ← shared tests | ||
| androidTest/ | ||
| iosTest/ |
nbransby
approved these changes
Mar 15, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
This pull request adds a comprehensive set of GitHub Copilot instructions for the
firebase-kotlin-sdkproject. The new documentation outlines the project's architecture, design principles, serialization guidelines, API compatibility goals, platform-specific notes, documentation and code style requirements, binary API validation process, testing instructions, and explicit guidance on practices to avoid.This will help maintain consistency and quality across contributions, especially when using GitHub Copilot.
Key additions and themes:
Project Structure and Design Principles
suspendfunctions,Flow, default arguments, infix notation, and operator overloading.Serialization and API Compatibility
kotlinx.serializationand outlines strategies for maintaining near-binary compatibility with the Firebase Android SDK, including naming conventions and API design.Platform-Specific Guidance
Documentation, Code Style, and Testing