Skip to content

docs(readme): 📝 improve discovery and first-use guidance - #29

Merged
zmo2s merged 1 commit into
mainfrom
docs/repository-discovery
Oct 15, 2026
Merged

zmo2s merged 1 commit into
mainfrom
docs/repository-discovery

Conversation

@zmo2s

@zmo2s zmo2s commented Oct 15, 2026

Copy link
Copy Markdown
Owner

Summary

Visitors can now try Good Commit through a short quick-start and find three concrete beginner tasks near the top of the README. Add a reproducible walkthrough of staged and unstaged edits within the same file, plus the social preview asset installed in repository settings.

Closes #19.

Test evidence

  • Existing demo: npm test passed, 6 tests.
  • Walkthrough reproduced in an isolated temporary Git repository: expected MM status and separate patches verified; 7 tests passed.
  • Relative documentation links and git diff --check passed.
  • Social preview exported at 1280 × 640 pixels, 90,711 bytes, and visually checked after upload.

Documentation impact

Adds the quick-start, beginner issue links, and partially staged walkthrough.

Security impact

None.

@zmo2s
zmo2s merged commit 2070e30 into main Oct 15, 2026
1 check passed
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.

Improve README and getting started guide

1 participant