openshift-developer: add hooks, skills, and workflow documentation #554
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| --- | ||
| name: git-commit-format | ||
| description: "Apply conventional commit formatting rules. Use when generating commit messages or creating commits." | ||
| --- | ||
|
|
||
| ## Name | ||
| openshift-developer:git-commit-format | ||
|
|
||
| ## Synopsis | ||
| ``` | ||
| /openshift-developer:git-commit-format | ||
| ``` | ||
|
|
||
| ## Description | ||
| Applies conventional commit formatting rules when generating commit messages. This skill is loaded as context for other skills and workflows — it defines the commit message format, required footers, and validation rules. | ||
|
|
||
| ## Implementation | ||
|
|
||
| ### Commit Message Format | ||
|
|
||
| ``` | ||
| <type>(<scope>): <description> | ||
|
|
||
| [optional body] | ||
|
|
||
| [footers] | ||
| ``` | ||
|
|
||
| ### Commit Types | ||
|
|
||
| - **feat**: New features | ||
| - **fix**: Bug fixes | ||
| - **docs**: Documentation changes | ||
| - **style**: Code style changes (formatting, etc.) | ||
| - **refactor**: Code refactoring (no functional changes) | ||
| - **test**: Adding/updating tests | ||
| - **chore**: Maintenance tasks | ||
| - **build**: Build system or dependency changes | ||
| - **ci**: CI/CD changes | ||
| - **perf**: Performance improvements | ||
| - **revert**: Revert previous commit | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| With `!` to draw attention: | ||
| ``` | ||
| feat!: send email when product shipped | ||
| ``` | ||
|
|
||
| With `BREAKING CHANGE` footer: | ||
| ``` | ||
| feat: allow config to extend other configs | ||
|
|
||
| BREAKING CHANGE: `extends` key now used for extending config files | ||
| ``` | ||
|
|
||
| ### Required Footers | ||
|
|
||
| #### Signed-off-by | ||
|
|
||
| **ALWAYS include `Signed-off-by`** footer with name and email. | ||
|
|
||
| Get credentials in this priority order: | ||
| 1. Environment variables: `$GIT_AUTHOR_NAME` and `$GIT_AUTHOR_EMAIL` | ||
| 2. Git config: `git config user.name` and `git config user.email` | ||
| 3. If neither configured, ask user to provide details | ||
|
|
||
| #### Commit-Message-Assisted-by | ||
|
|
||
| **ALWAYS include** when Claude assists with creating or generating the commit message: | ||
| ``` | ||
| Commit-Message-Assisted-by: Claude (via Claude Code) | ||
| ``` | ||
|
|
||
| ### Gitlint Validation Rules | ||
|
|
||
| - Run `make run-gitlint` to validate commit messages (if the repo has a gitlint target) | ||
| - **Title line**: 120 characters maximum | ||
| - **Body line**: 140 characters maximum per line | ||
| - Use conventional commit format | ||
| - Include required footers (Signed-off-by) | ||
| - No trailing whitespace | ||
|
|
||
| ## Return Value | ||
| - **Commit message**: A conventional commit message with type, scope, description, body, and all required footers | ||
|
|
||
| ## Examples | ||
|
|
||
| 1. **Simple commit**: | ||
| ``` | ||
| docs: correct spelling of CHANGELOG | ||
|
|
||
| Signed-off-by: Jane Doe <jdoe@example.com> | ||
| Commit-Message-Assisted-by: Claude (via Claude Code) | ||
| ``` | ||
|
|
||
| 2. **With scope**: | ||
| ``` | ||
| feat(azure): add workload identity support | ||
|
|
||
| Signed-off-by: Jane Doe <jdoe@example.com> | ||
| Commit-Message-Assisted-by: Claude (via Claude Code) | ||
| ``` | ||
|
|
||
| 3. **Multi-paragraph with footers**: | ||
| ``` | ||
| fix: prevent racing of requests | ||
|
|
||
| Introduce request ID and reference to latest request. Dismiss | ||
| incoming responses other than from latest request. | ||
|
|
||
| Remove timeouts which were used to mitigate racing but are | ||
| obsolete now. | ||
|
|
||
| Reviewed-by: John Smith | ||
| Refs: #123 | ||
| Signed-off-by: Jane Doe <jdoe@example.com> | ||
| Commit-Message-Assisted-by: Claude (via Claude Code) | ||
| ``` | ||
|
|
||
| ## Arguments | ||
| - None. This skill provides formatting rules as context for other skills and workflows. | ||
|
|
||
| ## Quick Checklist | ||
|
|
||
| When creating commits: | ||
| - [ ] Use conventional commit format: `<type>(<scope>): <description>` | ||
| - [ ] Title under 120 characters | ||
| - [ ] Body lines under 140 characters | ||
| - [ ] Include `Signed-off-by` footer | ||
| - [ ] Include `Commit-Message-Assisted-by: Claude (via Claude Code)` footer | ||
| - [ ] Validate with `make run-gitlint` if available | ||
| - [ ] Use "!" or `BREAKING CHANGE` for breaking changes | ||
|
|
||
| ## Reference | ||
|
|
||
| Conventional Commits Specification: https://www.conventionalcommits.org/en/v1.0.0/#specification |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,15 @@ | ||
| { | ||
| "name": "openshift-developer", | ||
| "description": "Bundle of curated plugins, skills, and MCP servers useful to any OpenShift engineer", | ||
| "version": "1.1.0", | ||
| "author": { | ||
| "name": "github.com/openshift-eng" | ||
| }, | ||
| "dependencies": [ | ||
| { "name": "jira", "version": "^0.7.0" }, | ||
| { "name": "ci", "version": "^0.0.42" }, | ||
| { "name": "golang", "version": "^0.3.0" }, | ||
| { "name": "prodsec-skills", "marketplace": "prodsec-skills" }, | ||
| { "name": "git", "version": "^0.0.6" } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| { | ||
| "hooks": { | ||
| "SessionStart": [ | ||
| { | ||
| "hooks": [ | ||
| { | ||
| "type": "command", | ||
| "command": "${CLAUDE_PLUGIN_ROOT}/scripts/ensure-precommit.sh" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| } |
|
stbenjam marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| #!/usr/bin/env bash | ||
| set -euo pipefail | ||
|
|
||
| if [ ! -f .pre-commit-config.yaml ]; then | ||
| exit 0 | ||
| fi | ||
|
|
||
| if ! command -v pre-commit &>/dev/null; then | ||
| echo "ERROR: pre-commit is required but not found on PATH" >&2 | ||
| exit 2 | ||
| fi | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" | ||
| python3 "$SCRIPT_DIR/validate_precommit_config.py" || exit $? | ||
|
|
||
| pre-commit install --hook-type pre-commit >&2 | ||
| pre-commit install --hook-type pre-push >&2 | ||
| echo "pre-commit hooks installed" >&2 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not 100% sure these skills belong here, should this remain as a meta-module that pulls in others?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Me neither, I put it here initially instead of in the git plugin to avoid bringing many of those specs which are unneeded here as a dependency. This skill has a concrete use case and as a principle seems easier to iterate with less deps.
I moved it there and added the dependency with the git plugin. I would expect eventually we enforce distribution of a .gitlint file that runs on precommit hook