Conventional Commit
Developmentconventional-commitConventional Commit is an Agent Skill for development published in the LibPDF-js/core repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Add and commit changes using conventional commits
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/LibPDF-js/core/blob/HEAD/.opencode/skills/conventional-commit/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/conventional-commit, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Create a git commit for the current changes using the Conventional Commits standard.
Context
Based on the conversation, determine what context is relevant for the commit message. If the user provided specific guidance about what to commit or the commit message, use that. Otherwise, analyze the changes to determine an appropriate commit message.
Process
-
Analyze the changes by running:
git statusto see all modified/untracked filesgit diffto see unstaged changesgit diff --stagedto see already-staged changesgit log --oneline -5to see recent commit style
-
Stage appropriate files:
- Stage all related changes with
git add - Do NOT stage files that appear to contain secrets (.env, credentials, API keys, tokens)
- If you detect potential secrets, warn the user and skip those files
- Stage all related changes with
-
Determine the commit type based on the changes:
feat: New feature or capabilityfix: Bug fixdocs: Documentation onlystyle: Formatting, whitespace (not CSS)refactor: Code restructuring without behavior changeperf: Performance improvementtest: Adding or updating testsbuild: Build system or dependenciesci: CI/CD configurationchore: Maintenance tasks, tooling, config
-
Determine the scope (optional):
- Use a short identifier for the affected area:
feat(parser):,fix(api): - Omit scope if changes are broad or scope is unclear
- Use a short identifier for the affected area:
-
Write the commit message:
- Subject line:
<type>[optional scope]: <description>- Use imperative mood ("add" not "added")
- Lowercase, no period at end
- Max 50 characters if possible, 72 hard limit
- Body (if needed): Explain why, not what
- Wrap at 72 characters
- Separate from subject with blank line
- Subject line:
Commit Format
<type>[scope]: <subject>
[optional body explaining WHY this change was made]
Examples
Simple change:
fix(parser): handle empty input without throwing
With body:
feat(api): add streaming response support
Large responses were causing memory issues in production.
Streaming allows processing chunks incrementally.
Rules
- NEVER commit files that may contain secrets
- NEVER use
git commit --amendunless the user explicitly requests it - NEVER use
--no-verifyto skip hooks - If the pre-commit hook fails, fix the issues and create a NEW commit
- If there are no changes to commit, inform the user and stop
- Use a HEREDOC to pass the commit message to ensure proper formatting
Execute
Run the git commands to analyze, stage, and commit the changes now.