docs: add README project overview and script guidance#2
docs: add README project overview and script guidance#2zakiscoding wants to merge 1 commit intomainzakiscoding/zakiscoding:mainfrom docs/repo-overview-readmezakiscoding/zakiscoding:docs/repo-overview-readmeCopy head branch name to clipboard
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a top-level README to improve repository discoverability and provide usage guidance for the realistic-sparse.ps1 utility script.
Changes:
- Document the repo’s project folder layout under
projects/*. - Add usage examples and safety notes for
realistic-sparse.ps1.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```powershell | ||
| ./realistic-sparse.ps1 -Branch main -StartDate 2025-01-01 -TotalDays 90 -DryRun | ||
| ./realistic-sparse.ps1 -Branch main -StartDate 2025-01-01 -TotalDays 90 | ||
| ./realistic-sparse.ps1 -Branch main -StartDate 2025-01-01 -TotalDays 90 -ForcePush | ||
| ``` | ||
|
|
||
| Notes: | ||
|
|
||
| - Use `-DryRun` to preview commit volume without writing commits. | ||
| - `-ForcePush` is optional and should only be used intentionally. |
There was a problem hiding this comment.
README documents -DryRun and -ForcePush parameters and shows examples using them, but realistic-sparse.ps1 currently defines only Branch, StartDate, and TotalDays (and always runs git push ... -f). This makes the usage guidance inaccurate and the safety notes misleading. Update the README to match the script’s actual parameters/behavior, or implement -DryRun (skip file writes/commits/push) and -ForcePush (only add -f when explicitly set).
Summary
ealistic-sparse.ps1 usage examples
Why
Improves discoverability and provides clear script usage guidance.