-
Notifications
You must be signed in to change notification settings - Fork 0
Add GitHub Copilot instructions for repository #14
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
Conversation
Co-authored-by: framinosona <2520362+framinosona@users.noreply.github.com>
Co-authored-by: framinosona <2520362+framinosona@users.noreply.github.com>
|
@copilot could you add also that this repo uses conventional commits format ? |
Co-authored-by: framinosona <2520362+framinosona@users.noreply.github.com>
Added conventional commits format guidelines in commit 2580ca7. The section includes:
|
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
This PR adds comprehensive GitHub Copilot instructions for the Plugin.ByteArrays project. The document provides detailed guidance on project structure, coding standards, testing practices, and development workflows.
- Added a 395-line copilot-instructions.md file covering all aspects of the project
- Documented technology stack, dependencies, and CI/CD pipeline details
- Included coding standards, testing guidelines, and performance best practices
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Configures
.github/copilot-instructions.mdto provide context-aware guidance for the repository.Changes
Project context: Overview of Plugin.ByteArrays as a .NET 9.0 library for byte array utilities with support for 60+ type conversions across
byte[],ReadOnlySpan<byte>, andReadOnlyMemory<byte>Development standards:
ByteArrayExtensions.*.cs).editorconfig(PascalCase types/methods,_camelCaseprivate fields)ToType()throws,ToTypeOrDefault()returns default,ref positionauto-advancesTesting patterns: xUnit with FluentAssertions, test naming
MethodName_Scenario_ExpectedBehavior, 616+ tests covering success/failure paths and boundary conditionsPerformance guidance: Prefer
ReadOnlySpan<byte>for zero-copy operations, usestackallocfor small buffers, avoid allocations in hot pathsCommon patterns vs anti-patterns:
Commit message format: Conventional Commits guidelines with type, scope, and subject format (e.g.,
feat(extensions): add ToDecimal conversion method), including common types (feat, fix, docs, style, refactor, perf, test, chore) and formatting rulesBuild/test/CI: Commands for
dotnet restore/build/test, GitHub Actions pipeline with versioning, NuGet publishing, and DocFX documentation deploymentDependencies: All packages from
Directory.Packages.propsincluding xUnit 2.9.3, FluentAssertions 7.2.0, .NET 9.0 SDKFixes ✨ Set up Copilot instructions #13
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.