Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
157 lines (109 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

157 lines (109 loc) · 3.32 KB
Raw

Contributing to data-architecture

Thank you for investing your time! Every skill you contribute makes Claude smarter for thousands of data architects.

Philosophy

We merge daily. If your PR passes CI, it gets merged same day. No waiting weeks for a review. Build something real, ship it, get credit.

Ways to Contribute

Type Effort Impact
Fix a typo or broken link 2 min 🟢 Easy first contribution
Improve an existing command 15 min 🟢 Good first issue
Add a reference document 30 min 🟡 Medium
Add a new slash command 1 hour 🟡 Medium
Build a new skill module 2-4 hours 🔴 High impact
Contribute a case study 1 hour 🟡 Medium

Adding a New Skill (Full Guide)

Step 1 — Fork and clone

git clone https://github.com/YOUR_USERNAME/data-architecture.git
cd data-architecture
npm install

Step 2 — Create your branch

git checkout -b skill/your-skill-name
# or
git checkout -b command/your-command-name
# or
git checkout -b example/your-case-study-name

Step 3 — Copy the skill template

cp -r templates/skill-template skills/your-skill-name
cd skills/your-skill-name

Step 4 — Fill in SKILL.md

This is the Claude instructions file. Follow the format:

---
name: your-skill-name
version: 1.0.0
description: One sentence. What does this skill teach Claude?
tags: [data-modeling, data-vault, cloud]
day: 1
commands:
  - your-command
---

# Skill: Your Skill Name

## Role
You are a [role]. When activated, you...

## Core Knowledge
...

## How to Use Commands
...

Keep SKILL.md under 200 lines. Put deep reference content in references/.

Step 5 — Fill in metadata.json

{
  "name": "your-skill-name",
  "version": "1.0.0",
  "description": "One sentence description",
  "author": "your-github-username",
  "day": 1,
  "tags": ["data-modeling"],
  "commands": ["your-command"],
  "references": []
}

Step 6 — Add commands (optional)

Each command is a .md file in skills/your-skill-name/commands/.

See templates/command-template.md for the format.

Step 7 — Validate locally

npm run validate

Fix any errors before opening a PR.

Step 8 — Commit and push

git add .
git commit -m "skill: add your-skill-name"
git push origin skill/your-skill-name

Step 9 — Open a PR

Use the PR template. Fill in all sections. Tag one maintainer for review.

Expected review time: same day.

PR Naming Conventions

skill: add day2-data-quality
command: add /governance-check to day2
example: add logistics-network case study
fix: correct vault pattern in day1-modeling
docs: update SKILL_SPEC with new frontmatter fields

Quality Bar

Your skill must:

  • Pass npm run validate with zero errors
  • Have a metadata.json that conforms to schemas/skill.schema.json
  • Have at least one working command in commands/
  • Not duplicate an existing skill (check skills/index.json)
  • Be tested against at least one real-world prompt

Code of Conduct

Be kind, be constructive, be curious. See CODE_OF_CONDUCT.md.

Questions?

Open a GitHub Discussion or create an issue tagged question.