-
-
Notifications
You must be signed in to change notification settings - Fork 687
feat(website): Add note about .gitignore only being respected in Git repositories #14443
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
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
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.
@copilot uldate it again. this markdown is generated via rust doc comments. update the doc comments instead
I explored adding the note via Rust doc comments in the The string replacement approach in > [!NOTE]
> `.gitignore` is only respected inside a Git repository. Commit: git-commit-hash-placeholder |
This is messy but it's the easiest impl |
Co-authored-by: camc314 <[email protected]>
777832e
to
551e4b8
Compare
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 a note to the CLI documentation stating that .gitignore
is only respected inside Git repositories. The change is made to the website documentation generation code that creates CLI help text from the oxc linter.
- Added a string replacement in the CLI documentation generator to insert a GitHub-style note
- Updated the corresponding test snapshot to reflect the new documentation format
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
File | Description |
---|---|
tasks/website/src/linter/cli.rs | Added string replacement logic to insert .gitignore note before "Handle Warnings" section |
tasks/website/src/linter/snapshots/cli.snap | Updated test snapshot to include the new .gitignore note in expected output |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.