Sitelet https://github.com/EvilBit-Labs/Stringy/blob/main/.github/commit-instructions.md
Skip to content

commit-instructions.md

Latest commit

 

History

History
32 lines (31 loc) · 1.73 KB

commit-instructions.md

File metadata and controls

32 lines (31 loc) · 1.73 KB
Raw

Commit Message Style for Stringy

  • Conventional Commits: All commits must follow Conventional Commits: <type>(<scope>): <description>
  • Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore
  • Scopes: (cli), (lib), (extraction), (classification), (container), (output), (types), (docs), (deps), (ci), (build), etc. Required for all commits.
  • Description:
    • Imperative mood ("add", not "added")
    • No period at the end
    • ≤72 characters, capitalized, clear and specific
  • Body (optional):
    • Start after a blank line
    • Use itemized lists for multiple changes
    • Explain what/why, not how
  • Footer (optional):
    • Start after a blank line
    • Use for issue refs (Closes #123) or breaking changes (BREAKING CHANGE:)
  • Breaking Changes:
    • Add ! after type/scope (e.g., feat(api)!: ...) or use BREAKING CHANGE: in footer
  • Examples:
    • feat(extraction): add UTF-16LE string extraction for PE binaries
    • fix(classification): improve URL pattern matching for edge cases
    • docs(readme): update installation instructions for Rust 1.85+
    • refactor(container): simplify ELF section parsing interface
    • test(classification): add semantic tagging validation tests
    • chore(deps): update goblin to v0.10.1 for security patches
    • perf(extraction): optimize string extraction for large binaries
    • feat(output): add JSON output format with ranking scores
    • feat(cli): add --min-length and --encoding filters
    • fix(container): handle corrupted PE section headers gracefully
  • CI Compatibility:
    • Use chore: for meta or maintenance changes
    • Use deps: scope for dependency updates