Add explicit treefmt formatting instruction to copilot-instructions.md#1370
Merged
brianmcgillion merged 2 commits intomainfrom Sep 4, 2025
Merged
Add explicit treefmt formatting instruction to copilot-instructions.md#1370brianmcgillion merged 2 commits intomainfrom
brianmcgillion merged 2 commits intomainfrom
Conversation
Co-authored-by: brianmcgillion <1044263+brianmcgillion@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] fix copilot-instructions.md to ensure formatting
Add explicit treefmt formatting instruction to copilot-instructions.md
Sep 4, 2025
brianmcgillion
approved these changes
Sep 4, 2025
Copilot AI
added a commit
that referenced
this pull request
Sep 4, 2025
#1370) * Initial plan * Add explicit treefmt formatting instruction to copilot-instructions.md Co-authored-by: brianmcgillion <1044263+brianmcgillion@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: brianmcgillion <1044263+brianmcgillion@users.noreply.github.com>
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 PR enhances the GitHub Copilot instructions to explicitly emphasize the requirement for proper code formatting using treefmt before making pull requests.
Changes Made
Enhanced Development Workflow Section
nix fmt(to format code) andnix fmt -- --fail-on-change(to validate formatting)Updated Validation Steps
Why This Matters
The previous instructions mentioned
nix fmt -- --fail-on-changebut didn't explicitly connect it to treefmt or emphasize the critical importance of formatting commits before PRs. This enhancement makes it crystal clear that:This will help prevent formatting-related CI failures and ensure consistent code style across the Ghaf Framework codebase.
Fixes #1369.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.