Rewite the docs and Copilot instructions#3442
Merged
Merged
Conversation
Contributor
|
Triage Summary Labels will be applied to indicate the affected areas of the backend (SkiaSharp) and documentation related to project clarity. This issue is not a regression as it focuses solely on documentation refactoring and instruction improvements without impacting functionality. Additional remarks:
Detailed Summary and ActionsSummary of the triage:
Summary of the actions that will be performed:
This entire triage process was automated by AI and mistakes may have been made. Please let us know so we can continue to improve. |
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 refactors and reorganizes the AI assistant instructions for the SkiaSharp project. The changes focus on improving clarity, consolidating information, and making the instructions more concise and easier to follow for contributors and AI coding agents. The most important updates include a major rewrite of the main Copilot instructions, removal of redundant content, and streamlining of layer-specific instruction files.
Major documentation and instruction refactoring:
.github/copilot-instructions.md: Completely rewritten to provide a clear, architecture-focused overview for AI assistants, including pointer types, error handling, directory structure, build/generation steps, and layer-specific rules. The new format uses tables, decision trees, and concise code examples for better readability and guidance.Streamlining and consolidation of instruction files:
.github/instructions/README.md: Removed the previous lengthy overview and usage guide for path-specific instructions, consolidating this content into the main Copilot instructions and layer-specific files.Layer-specific instruction improvements:
Group: C API Layer
.github/instructions/c-api-layer.instructions.md: Removed redundant frontmatter and improved the focus and clarity of rules, patterns, and examples for working in the C API bridging layer.Group: C# Bindings Layer
.github/instructions/csharp-bindings.instructions.md: Removed redundant frontmatter and streamlined the rules and examples for C# wrapper development, emphasizing proper handle management, validation, and error handling.Group: Documentation
.github/instructions/documentation.instructions.md: Removed redundant frontmatter and clarified standards for writing project documentation, including code example best practices and structure guidelines.