Add Copilot instructions for Syncfusion .NET MAUI Toolkit #292
Conversation
Added comprehensive instructions for using GitHub Copilot with the Syncfusion .NET MAUI Toolkit, covering repository overview, technology targeting, local development setup, build notes, code style, bug fix and feature workflows, testing strategy, performance guidelines, accessibility, documentation, CI integration, release/versioning, and common pitfalls.
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive Copilot instructions for the Syncfusion .NET MAUI Toolkit repository, providing AI-assisted development guidance across 22 major sections covering repository structure, development workflows, coding standards, testing strategy, and common pitfalls.
Key changes:
- Adds detailed documentation for repository structure, build configuration, and multi-target framework support
- Documents coding conventions derived from .editorconfig and CONTRIBUTING.md
- Provides step-by-step workflows for bug fixes, feature implementation, and testing
- Includes troubleshooting guidance and command reference for common development tasks
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
.github/instructions/copilot-instructions.md:1
- The note about 'some files use
.ios.cs' appears to be inaccurate. A search of the codebase found no files using the lowercase.ios.cssuffix. The MultiTargeting.targets file only references.iOS.cs(with capital 'S'). Consider simplifying this to: 'Platform-specific source segregation via filename suffixes:.Android.cs,.iOS.cs,.MaciOS.cs,.Mac.cs,.Windows.cs,.Standard.cs(note: use capital 'S' in.iOS.cs).' This removes the potentially confusing reference to a pattern that doesn't exist in the codebase.
# Copilot Instructions for Syncfusion® Toolkit for .NET MAUI
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.github/workflows/pr-quality.yml
Outdated
| guidance-comment: | ||
| if: github.event.action == 'opened' | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Post QA Guidance Comment | ||
| uses: peter-evans/create-or-update-comment@v3 | ||
| with: | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| body: | | ||
| Thanks for opening this PR! Please ensure the [Quality Assurance Checklist](.github/instructions/copilot-instructions.md#quality-assurance-checklist) in `.github/instructions/copilot-instructions.md` is fully addressed: | ||
| - Multi-target build (`Release-Xml`) success | ||
| - Analyzer warnings resolved | ||
| - Tests added/updated and passing | ||
| - XML docs for public API changes | ||
| - Platform parity & accessibility | ||
| - Performance & memory considerations | ||
| If any item is not applicable, clarify reasoning in the PR description. |
There was a problem hiding this comment.
The guidance-comment job that posts PR comments should specify permissions to follow the principle of least privilege. Without explicit permissions, the workflow inherits default permissions which may be broader than necessary.
Consider adding:
permissions:
pull-requests: writeThis restricts the job to only what it needs: the ability to write comments on pull requests.
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
Co-authored-by: Copilot <[email protected]>
|
@PaulAndersonS I've opened a new pull request, #293, to work on those changes. Once the pull request is ready, I'll request review from you. |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot i dont want pr-queality workflow. copilot-instructions alone enough. can you remove that |
|
@PaulAndersonS I've opened a new pull request, #294, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: PaulAndersonS <[email protected]>
Remove pr-quality workflow per user request
Added comprehensive instructions for using GitHub Copilot with the Syncfusion .NET MAUI Toolkit, covering repository overview, technology targeting, local development setup, build notes, code style, bug fix and feature workflows, testing strategy, performance guidelines, accessibility, documentation, CI integration, release/versioning, and common pitfalls.
Root Cause of the Issue
Description of Change
Issues Fixed
Fixes #
Screenshots
Before:
After: