-
Notifications
You must be signed in to change notification settings - Fork 17
feat: contribute to Holdex repos using a structured Claude Code skill #100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
07e1f36
b17fc39
5804351
ba2782f
655a8d0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| name: holdex-contributing | ||
| description: Holdex contributing rules for GitHub issues and PRs. Invoke before creating or updating issues or PRs in any Holdex repository. | ||
| --- | ||
|
|
||
| All PRs and issues must follow the | ||
| [Holdex Contributing Guidelines](https://github.com/holdex/developers/blob/main/docs/CONTRIBUTING.md). | ||
|
|
||
| ## Issues | ||
|
|
||
| - Name: `Problem: [statement]` — must be a **job story** describing what a | ||
| specific user **cannot do** (the whole title under 65 characters). | ||
| - Good: `employees can't safely handle fund disbursements` | ||
| - Bad: `fund handling issue` | ||
|
Comment on lines
+11
to
+14
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Make the “Good” issue example match the required format. You require Suggested doc update- - Good: `employees can't safely handle fund disbursements`
+ - Good: `Problem: employees can't safely handle fund disbursements`🤖 Prompt for AI Agents |
||
| - Link each Problem as a **sub-issue** of its parent Goal issue. | ||
| - When referencing other issues or PRs, always use a **list item**, never | ||
| inline: | ||
|
|
||
| ```md | ||
| - <https://github.com/holdex/hr-internal/issues/123> | ||
| ``` | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| - **Title**: `type(scope): action` — user-focused, present tense, Conventional | ||
| Commits format. | ||
| - Good: `docs: protect client funds from unauthorized contractor custody` | ||
| - Bad: `Add FUND_HANDLING.md` | ||
| - **Scope**: fits within 3–4 hours of work. Decompose if larger. | ||
| - **Lifecycle** (in order): | ||
| 1. Open as a **draft PR** immediately when starting work. | ||
| 1. Link to the Problem issue using a closing keyword (`Closes #123`). | ||
| 1. Assign yourself. | ||
| 1. Resolve all CI checks. | ||
| 1. Assign at least one reviewer. | ||
| 1. Mark ready for review only when all steps above are done. | ||
| - **Do not merge** without an approved review. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,3 +22,18 @@ Align with: | |
|
|
||
| Subscribe to repository notifications to stay updated with frequent fixes and | ||
| improvements. | ||
|
|
||
| ## Claude Code Skills | ||
|
|
||
| Clone this repository locally and symlink the commands directory to make all | ||
| skills available globally across every repo you work in: | ||
|
|
||
| ```bash | ||
| ln -s /path/to/holdex/developers/.claude/commands ~/.claude/commands | ||
| ``` | ||
|
Comment on lines
+31
to
+33
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Harden the symlink setup command to avoid common setup failures. On Line 32, Suggested doc update ```bash
-ln -s /path/to/holdex/developers/.claude/commands ~/.claude/commands
+mkdir -p ~/.claude
+ln -sfn /path/to/holdex/developers/.claude/commands ~/.claude/commands🤖 Prompt for AI Agents |
||
|
|
||
| Skills stay up to date automatically as you pull the repo. Available skills: | ||
|
|
||
| | Command | When to use | | ||
| | --- | --- | | ||
| | `/holdex-contributing` | Before creating or updating a GitHub issue or PR in any Holdex repository | | ||
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.
Add a level-1 heading after front matter.
Markdownlint MD041 is valid here. Add a top-level heading (for example
# holdex-contributing) right after the front matter block.🧰 Tools
🪛 GitHub Check: checks
[warning] 6-6: MD041
First line in file should be a level 1 heading
🤖 Prompt for AI Agents