-
-
Notifications
You must be signed in to change notification settings - Fork 4
✨ Set up Copilot instructions for ScanBridge repository #100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: Chrisimx <54219305+Chrisimx@users.noreply.github.com>
Co-authored-by: Chrisimx <54219305+Chrisimx@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Sets up comprehensive GitHub Copilot instructions to help AI assistants better understand and contribute to the ScanBridge Android scanning app project. This follows GitHub's best practices for Copilot coding agents.
Key changes:
- Adds detailed project context about ScanBridge's Android/Kotlin architecture
- Documents development guidelines, coding conventions, and testing procedures
- Provides scanner-specific domain knowledge for eSCL/AirScan protocol support
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - Run `./ktlint --editorconfig=./.editorconfig` to check formatting | ||
| - Run `./ktlint --editorconfig=./.editorconfig --format` to fix formatting |
Copilot
AI
Sep 27, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The ktlint commands reference a local ./ktlint executable, but ktlint is typically installed as a Gradle plugin or standalone tool. Consider clarifying the installation method or using the more common ./gradlew ktlintCheck and ./gradlew ktlintFormat Gradle tasks.
| - Run `./ktlint --editorconfig=./.editorconfig` to check formatting | |
| - Run `./ktlint --editorconfig=./.editorconfig --format` to fix formatting | |
| - Run `./gradlew ktlintCheck` to check formatting | |
| - Run `./gradlew ktlintFormat` to fix formatting |
This PR adds comprehensive GitHub Copilot instructions to help AI assistants better understand and contribute to the ScanBridge project. The instructions follow GitHub's best practices for Copilot coding agents and provide detailed context about the project's architecture, coding standards, and development workflows.
What's Added
📝
.github/copilot-instructions.md- A comprehensive guide covering:Key Benefits
Technical Details
The instructions are structured as clear Markdown sections with code examples showing:
This will help both human developers and AI assistants maintain consistency with the project's established patterns and contribute more effectively to ScanBridge development.
Resolves #[issue_number]
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.