Skip to content

Add comprehensive GitHub Copilot instructions for firebase-kotlin-sdk#808

Merged
Reedyuk merged 2 commits intomasterfrom
Reedyuk-copilot-instructions
Mar 15, 2026
Merged

Add comprehensive GitHub Copilot instructions for firebase-kotlin-sdk#808
Reedyuk merged 2 commits intomasterfrom
Reedyuk-copilot-instructions

Conversation

@Reedyuk
Copy link
Collaborator

@Reedyuk Reedyuk commented Mar 15, 2026

This pull request adds a comprehensive set of GitHub Copilot instructions for the firebase-kotlin-sdk project. 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

  • Provides an overview of the SDK's multiplatform architecture, module structure, and Kotlin-first design principles, including the use of suspend functions, Flow, default arguments, infix notation, and operator overloading.

Serialization and API Compatibility

  • Details serialization requirements using kotlinx.serialization and outlines strategies for maintaining near-binary compatibility with the Firebase Android SDK, including naming conventions and API design.

Platform-Specific Guidance

  • Explains platform-specific considerations for Android, iOS, JVM/Desktop, and how to access underlying native SDKs via extension properties in the appropriate source sets.

Documentation, Code Style, and Testing

  • Establishes requirements for KDoc on all public APIs, adherence to IntelliJ Kotlin code style, use of formatting/linting tools, binary API validation, and instructions for running tests across platforms. (.github/copilot-instructions.mdR1-R214

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.
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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.

Comment on lines +24 to +26
commonTest/ ← shared tests
androidTest/
iosTest/
@Reedyuk Reedyuk disabled auto-merge March 15, 2026 14:57
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@Reedyuk Reedyuk merged commit aab3a5f into master Mar 15, 2026
@Reedyuk Reedyuk deleted the Reedyuk-copilot-instructions branch March 15, 2026 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants