Commit Message Style for mmap-guard#
Use Conventional Commits: <type>(<scope>): <description>
- Types:
feat,fix,docs,style,refactor,perf,test,build,ci,chore - Scopes (required):
mmap,io,lib,api,safety,docs,test,ci,deps,security, etc. - Description: imperative, capitalized, ≤72 chars, no period
- Body (optional): blank line, bullet list, explain what/why
- Footer (optional): blank line, issue refs (
Closes #123) orBREAKING CHANGE: - Breaking changes: add
!after type/scope or useBREAKING CHANGE:
Examples:
feat(mmap): add pre-flight stat check before mappingfix(io): handle empty files gracefully in map_filedocs(api): add rustdoc examples for FileDatachore(deps): update memmap2 to v0.9 for security patches