Skip to content

docs: add gitignore one-liners to README Quick Start#11

Draft
archon-instinct[bot] wants to merge 3 commits into
mainfrom
fix/issue-10
Draft

docs: add gitignore one-liners to README Quick Start#11
archon-instinct[bot] wants to merge 3 commits into
mainfrom
fix/issue-10

Conversation

@archon-instinct

Copy link
Copy Markdown

Summary

  • Added two idempotent copy-paste shell snippets to the README Quick Start section, placed immediately after the ./git-author-reformer run block and before ## What It Does
  • Project .gitignore one-liner: uses grep -qxF whole-line guard with 2>/dev/null fallback and || append — safe to run multiple times, creates the file if absent
  • Global excludesfile snippet: resolves core.excludesfile (defaulting to ~/.gitignore_global if unset), then applies the same idempotent append guard

Changes

  • README.md — Quick Start section updated with gitignore instructions

Verification

All 3 must-haves verified (score 3/3):

Check Result
Project .gitignore one-liner present in Quick Start PASS
Global excludesfile snippet present in Quick Start PASS
Both snippets use exact binary name git-author-reformer (no platform suffixes) PASS

Automated spot-checks:

  • grep -c "grep -qxF 'git-author-reformer'" README.md → 2 ✓
  • grep -q "core.excludesfile" README.md → match found ✓
  • Snippets appear after run block (line 20), before ## What It Does (line 38) ✓
  • No -linux-x86_64 / -macos-aarch64 suffixes in gitignore snippets ✓

Fixes #10

…tart

- Add project .gitignore idempotent one-liner using grep -qxF guard
- Add global excludesfile snippet that resolves-or-sets core.excludesfile then appends idempotently
- Both snippets target the exact binary name 'git-author-reformer'
- Placed immediately after the ./git-author-reformer run block, before What It Does
… downloaded binary to both project and global gitignore
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

adding binary to gitignore instructions

1 participant