-
Notifications
You must be signed in to change notification settings - Fork 1
Add comprehensive GitHub Copilot instructions for contributors #8
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
Also make sure you fetch the history of the repo to make gitversion work correctly |
Co-authored-by: eNeRGy164 <10671831+eNeRGy164@users.noreply.github.com>
Added detailed guidance about fetching complete git history for GitVersion: - Explains fetch-depth: 0 requirement in GitHub Actions - Provides git fetch --unshallow command for local development - Documents why full history is needed for proper versioning Addresses feedback about ensuring GitVersion works correctly. Co-authored-by: eNeRGy164 <10671831+eNeRGy164@users.noreply.github.com>
Added comprehensive GitVersion requirements section to the Copilot instructions, including the |
Pull Request Test Coverage Report for Build 15927838055Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
Instead of squash commit, group changes logically over one or more commits. |
Reorganized commits into logical grouping by removing the "initial plan" commit and keeping two meaningful commits: the main comprehensive instructions and the GitVersion requirements addition. Changes in commit 24840cb. |
Update Pull Request Guidelines to reflect feedback: - Group changes logically over one or more commits instead of squashing - Document that force push is allowed on feature branches for history reorganization - Aligns with project preference for meaningful commit organization
Co-authored-by: eNeRGy164 <10671831+eNeRGy164@users.noreply.github.com>
Co-authored-by: eNeRGy164 <10671831+eNeRGy164@users.noreply.github.com>
Added guidelines for logical commit grouping and force push allowance to the Git Workflow section. The instructions now include: "Group changes logically over one or more commits instead of squashing everything" and "Force push is allowed on feature branches for history reorganization". |
This PR adds comprehensive GitHub Copilot instructions to optimize AI-assisted contributions to the DendroDocs.Client library.
Changes Made
Created
.github/copilot-instructions.md
containing detailed guidelines for:Core Requirements
is null
over== null
- Documented with clear examples and rationaleClean
,Compile
,UnitTests
, etc.) and proper usageAdditional Best Practices
Based on analysis of the existing codebase patterns:
ArgumentNullException.ThrowIfNull()
Example Guidelines
Verification
.editorconfig
standardsThe instructions provide comprehensive guidance while respecting the project's existing high-quality code patterns and architectural decisions.
Fixes #7.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.