|
| 1 | +# Contributing to OpenKB |
| 2 | + |
| 3 | +Thanks for your interest in OpenKB! There are two ways to contribute: code (bug |
| 4 | +fixes, new features) and skills (compiled knowledge artifacts). |
| 5 | + |
| 6 | +## Code contributions |
| 7 | + |
| 8 | +Standard GitHub workflow: |
| 9 | + |
| 10 | +1. Fork the repo and create a feature branch off `main`. |
| 11 | +2. Add tests for any new behaviour. Run `uv run pytest` to verify they pass. |
| 12 | +3. Open a PR with a clear description and link to any related issues. |
| 13 | +4. Address review feedback. A maintainer will merge once everything looks good. |
| 14 | + |
| 15 | +## Submitting a skill |
| 16 | + |
| 17 | +OpenKB doubles as a registry for compiled-knowledge skills. The `skills/` |
| 18 | +directory in this repo hosts the official `openkb` skill plus |
| 19 | +community-contributed skills installable via: |
| 20 | + |
| 21 | +```bash |
| 22 | +npx skills@latest add VectifyAI/OpenKB |
| 23 | +``` |
| 24 | + |
| 25 | +To submit your skill: |
| 26 | + |
| 27 | +### 1. Compile and test locally |
| 28 | + |
| 29 | +```bash |
| 30 | +cd <your-kb> |
| 31 | +openkb skill new <skill-name> "<one-sentence intent>" |
| 32 | +cp -r output/skills/<skill-name> ~/.claude/skills/ |
| 33 | +# Verify the skill activates in a Claude Code session on a relevant question |
| 34 | +``` |
| 35 | + |
| 36 | +### 2. Open a PR against this repo |
| 37 | + |
| 38 | +1. Fork `VectifyAI/OpenKB`. |
| 39 | +2. Copy your skill into the fork at `skills/<your-skill-name>/`. |
| 40 | +3. Add a new entry under `plugins[0].skills` in `.claude-plugin/marketplace.json`: |
| 41 | + ```json |
| 42 | + "./skills/<your-skill-name>" |
| 43 | + ``` |
| 44 | +4. Open a PR with the "Skill submission" template (auto-applied when you create |
| 45 | + the PR). |
| 46 | + |
| 47 | +### 3. Review |
| 48 | + |
| 49 | +A maintainer will review your submission against this checklist: |
| 50 | + |
| 51 | +- `SKILL.md` has a valid YAML frontmatter with `name:` and `description:` |
| 52 | + (description ≤ 1024 characters). |
| 53 | +- The `description` is specific (not "a skill about X"). |
| 54 | +- All `[[references/...]]` links resolve to files you actually included. |
| 55 | +- Skill name doesn't clash with an existing entry. |
| 56 | +- No obvious copyright-infringing content (large verbatim copies of recent |
| 57 | + copyrighted books or papers without authorisation). |
| 58 | + |
| 59 | +You're responsible for confirming you have rights to redistribute the source |
| 60 | +material your skill is derived from. The PR template includes a checkbox for |
| 61 | +this. |
| 62 | + |
| 63 | +### What makes a good community skill |
| 64 | + |
| 65 | +- **Methodology-focused**, not bulk-copied content. "How to reason about X" |
| 66 | + beats "the full text of X". |
| 67 | +- **Specific scope** so the `description:` field can be precise enough that |
| 68 | + loading agents pick it up at the right time. |
| 69 | +- **Tested in at least one agent CLI** before submission. |
| 70 | + |
| 71 | +Thanks for sharing what you've compiled! |
0 commit comments