Commit ddc369d
docs: update README for untracked and working-tree files (#2459)
## Description
Updates `scripts/linting/README.md` to accurately reflect the
working-tree validation and untracked-file discovery changes introduced
in commit `deb66e4` (PR #2437).
**Changes made:**
- **Markdown-Link-Check.ps1:** Added a feature bullet noting the
discovery of tracked and untracked, non-ignored Markdown files so local
validation does not require staging.
- **Get-ChangedFilesFromGit:**
- Updated the main description to clarify that working-tree
(staged/unstaged) and untracked files are always supplemented,
regardless of branch context.
- Expanded the "Fallbacks" list to accurately document all 4 distinct
git queries (including the new `git ls-files --others
--exclude-standard` step).
## Related Issue(s)
Fixes #2448
## Type of Change
Select all that apply:
**Code & Documentation:**
* [ ] Bug fix (non-breaking change fixing an issue)
* [ ] New feature (non-breaking change adding functionality)
* [ ] Breaking change (fix or feature causing existing functionality to
change)
* [x] Documentation update
**Infrastructure & Configuration:**
* [ ] GitHub Actions workflow
* [ ] Linting configuration (markdown, PowerShell, etc.)
* [ ] Security configuration
* [ ] DevContainer configuration
* [ ] Dependency update
**Other:**
* [ ] Script/automation (`.ps1`, `.sh`, `.py`)
* [ ] Other (please describe):
## Checklist
### Required Checks
* [x] Documentation is updated (if applicable)
* [x] Files follow existing naming conventions
* [x] Changes are backwards compatible (if applicable)
* [ ] Tests added for new functionality (if applicable)
### Required Automated Checks
The following validation commands must pass before merging:
* [x] Markdown linting: `npm run lint:md`
* [x] Spell checking: `npm run spell-check`
* [x] Frontmatter validation: `npm run lint:frontmatter`
* [ ] Skill structure validation: `npm run validate:skills` *(N/A - no
skill files changed)*
* [ ] Link validation: `npm run lint:md-links` *(N/A - no URLs
added/modified)*
* [ ] PowerShell analysis: `npm run lint:ps` *(N/A - no .ps1/.psm1 files
changed)*
* [ ] Eval spec schema and coverage (if AI artifacts changed): `npm run
eval:lint:schema` *(N/A)*
* [ ] Plugin freshness: `npm run plugin:generate` *(N/A)*
* [ ] Docusaurus tests: `npm run docs:test` *(N/A)*
## Security Considerations
* [x] This PR does not contain any sensitive or NDA information
* [ ] Any new dependencies have been reviewed for security issues *(N/A
- no new dependencies)*
* [ ] Security-related scripts follow the principle of least privilege
*(N/A)*
Co-authored-by: Jamie Kim <jamiekim500@gmail.com>1 parent 8befd01 commit ddc369d
1 file changed
Lines changed: 4 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
234 | 234 | | |
235 | 235 | | |
236 | 236 | | |
| 237 | + | |
237 | 238 | | |
238 | 239 | | |
239 | 240 | | |
| |||
569 | 570 | | |
570 | 571 | | |
571 | 572 | | |
572 | | - | |
| 573 | + | |
573 | 574 | | |
574 | 575 | | |
575 | 576 | | |
| |||
582 | 583 | | |
583 | 584 | | |
584 | 585 | | |
585 | | - | |
| 586 | + | |
| 587 | + | |
586 | 588 | | |
587 | 589 | | |
588 | 590 | | |
| |||
0 commit comments