pre-commit-msg

Automagically prefix and format commit messages when committing

https://github.com/boidolr/pre-commit-msg

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.4%) to scientific vocabulary

Keywords

git git-hooks pre-commit

Keywords from Contributors

avif image-optimization jpeg png refactoring wavelets documents interpretability ros robustness
Last synced: 4 months ago · JSON representation ·

Repository

Automagically prefix and format commit messages when committing

Basic Info
  • Host: GitHub
  • Owner: boidolr
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 502 KB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 7
Topics
git git-hooks pre-commit
Created almost 4 years ago · Last pushed 4 months ago
Metadata Files
Readme License Citation Codeowners

README.md

pre-commit-msg tag python Build

pre-commit

A collection of prepare message and commit message git hooks for use with the pre-commit framework. For details see the list of available hooks below.

Using pre-commit-msg with pre-commit

Add this to your .pre-commit-config.yaml: - repo: https://github.com/boidolr/pre-commit-msg rev: v1.3.2 # Use the ref you want to point at hooks: - id: format-message # - id: ... For an extended example see .pre-commit-config.yaml.

Available hooks

  • prepare-message: Change commit messages to include a prefix.
    • --ignore-branch will lead to the branch not being checked.
    • --pattern can be used to change the feature branch pattern to take the message prefix from. Needs to match with --prefix-pattern. Defaults to feature/(\w+-\d+).
    • --prefix-pattern should match the prefix of the message to normalize it. Needs to match with --pattern. Defaults to ^\s*\w+-\d+\s*:
  • format-message: Ensure commit message conforms to format of headline followed by two empty lines.
    • --capitalize if the subject line should be capitalized. Other lines remain unchanged.

Owner

  • Name: Raphael Boidol
  • Login: boidolr
  • Kind: user
  • Location: Munich, Germany
  • Company: @TNG

coding for the fun of it

Citation (CITATION.cff)

'cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Boidol"
  given-names: "Raphael"
title: "pre-commit-msg"
abstract: >-
  pre-commit-msg updates commit messages for you, simplifying the development process.
license: MIT
license-url: "https://github.com/boidolr/pre-commit-msg/blob/main/LICENSE"
repository-code: "https://github.com/boidolr/pre-commit-msg"
url: "https://github.com/boidolr/pre-commit-msg"

GitHub Events

Total
  • Delete event: 66
  • Push event: 89
  • Pull request review event: 1
  • Pull request event: 127
  • Create event: 63
Last Year
  • Delete event: 66
  • Push event: 89
  • Pull request review event: 1
  • Pull request event: 127
  • Create event: 63

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 313
  • Total Committers: 5
  • Avg Commits per committer: 62.6
  • Development Distribution Score (DDS): 0.425
Past Year
  • Commits: 102
  • Committers: 2
  • Avg Commits per committer: 51.0
  • Development Distribution Score (DDS): 0.137
Top Committers
Name Email Commits
renovate[bot] 2****] 180
Raphael Boidol b****r 62
github-actions 4****] 52
github-actions g****s@g****m 16
Renovate Bot b****t@r****m 3
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 1
  • Total pull requests: 136
  • Average time to close issues: less than a minute
  • Average time to close pull requests: about 3 hours
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 126
  • Bot issues: 1
  • Bot pull requests: 126
Past Year
  • Issues: 1
  • Pull requests: 118
  • Average time to close issues: less than a minute
  • Average time to close pull requests: about 3 hours
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 108
  • Bot issues: 1
  • Bot pull requests: 108
Top Authors
Issue Authors
  • renovate[bot] (1)
Pull Request Authors
  • renovate[bot] (237)
  • boidolr (17)
Top Labels
Issue Labels
dependencies (1) pep621 (1)
Pull Request Labels
dependencies (237) github-tags (159) github-actions (98) pep621 (67) pre-commit (61) github-releases (10) regex (10) poetry (1)

Dependencies

.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/continous-integration.yml actions
  • actions/checkout v3 composite
  • boidolr/actions/python-pip-env main composite
  • boidolr/actions/run-precommit main composite
.github/workflows/create-release.yml actions
  • boidolr/actions/create-release main composite
.github/workflows/pre-commit-update.yml actions
  • actions/checkout v3 composite
  • boidolr/actions/git-push main composite
  • boidolr/actions/run-precommit main composite
pyproject.toml pypi