git-commit-non-code

What problem does it solve?

Helps maintain consistent, safe git commits for non-code changes (documentation, configuration, and other repository metadata) so those edits are recorded properly, annotated for CI behavior, and optionally published to the remote.

Core Features & Use Cases

• Structured commit creation: Ensures relevant non-code files are staged and committed with a clear message.
• CI annotation support: Reminds or includes CI-skip comments when required by project CI providers.
• Optional push behavior: Allows pushing the commit to the remote when requested.
• Use Case: Updating README or config files and creating a commit that skips CI to avoid unnecessary pipeline runs while preserving a clear history.

Quick Start

Create a git commit for the current non-code documentation and configuration changes, include any CI-skip comments, and push to the remote if the push-commit option is true.