Skip to content

Add QUICKSTART.md guide and link from README#7

Merged
Techikrish merged 1 commit into
mainfrom
docs/add-quick-start-examples
Jan 2, 2026
Merged

Add QUICKSTART.md guide and link from README#7
Techikrish merged 1 commit into
mainfrom
docs/add-quick-start-examples

Conversation

@Techikrish

Copy link
Copy Markdown
Owner
  • Add 60-second quick start guide with practical examples
  • Show how to install, test, and use ShieldCommit
  • Include troubleshooting tips
  • Link from README for better discoverability

Description

Related Issue

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 📚 Documentation update
  • 🔧 Chore (CI/CD, dependencies, configuration)

Testing

  • Tests added/updated
  • All 92 tests passing locally
  • Code coverage > 80%

Test command:

pytest tests/ -v

Checklist

  • My code follows the PEP 8 style guide
  • I have performed a self-review of my own code
  • I have added tests for new functionality
  • All new and existing tests pass
  • I have updated documentation (if needed)
  • My changes do not introduce breaking changes
  • PR targets develop branch (not main)

Additional Context

- Add 60-second quick start guide with practical examples
- Show how to install, test, and use ShieldCommit
- Include troubleshooting tips
- Link from README for better discoverability
@Techikrish
Techikrish merged commit d3da6bd into main Jan 2, 2026
5 checks 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.

1 participant