Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (54 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

77 lines (54 loc) · 3.22 KB

Contributing

Thanks for your interest in awesome-skills! This repo curates and re-distributes Claude Code / Codex skills from upstream projects. The day-to-day content (skills/*) is refreshed automatically every Sunday by a GitHub Actions workflow — most contributions are about which upstream sources to include, how to filter, and packaging quality.

What we accept

Contribution How to submit
Add a new upstream source Open a skill-source issue or PR adding it to scripts/sync_skills.py
Remove or down-prioritize an upstream Issue or PR with rationale
Fix a broken skill Issue with the skill name, what's broken, and a reproducer
Improve the installer PR — see install.sh testing
Improve the sync logic PR — see sync script testing
Documentation / README polish PR — keep the awesome-list table format consistent

We do not accept direct edits to files inside skills/. Those get overwritten by the weekly sync. Send your fix upstream to the original repo (linked in the README) and it will flow back here.

Adding a new upstream source

  1. Open the new-source issue template.
  2. Include: repo URL, star count, license, approximate skill count, focus area, and why it complements (not duplicates) existing sources.
  3. If accepted, add to UPSTREAMS in scripts/sync_skills.py. Order matters — later entries win on name collision. Place P0/specialized sources last.
  4. Run python scripts/sync_skills.py locally and verify no LFS/large-file issues.
  5. Open a PR. The workflow will run on the PR; the bot will not push from PR branches.

Reporting a problematic skill

If a skill ships a file that breaks git push (LFS pointer without blob, file >40 MB, etc.) or contains questionable content:

  1. Open the broken-skill issue.
  2. Include the offending path under skills/....
  3. We'll either add a filter rule to scripts/sync_skills.py or drop the source.

Testing the sync script

# Smoke-run (no destination write — operates on the repo's own ./skills/)
python scripts/sync_skills.py

# Check delta vs HEAD
git status --porcelain skills/ | head -20

Testing install.sh

# Static check
shellcheck install.sh

# Help text
bash install.sh --help

# Dry run against fake destinations
SKILLS_CLAUDE_DEST=/tmp/awesome-test/c \
SKILLS_CODEX_DEST=/tmp/awesome-test/x \
bash install.sh --dry-run

# Full curl pipe round-trip (after pushing your branch)
curl -fsSL https://raw.githubusercontent.com/FridrichMethod/awesome-skills/<your-branch>/install.sh | bash -s -- --dry-run

Coding style

  • Shell: pass shellcheck -s bash -e SC2155.
  • Python: pass ruff check. The pre-commit config covers both.
  • Workflows: pass actionlint.
  • Markdown: keep tables aligned by column.

Install hooks once with:

pip install pre-commit && pre-commit install

License

By contributing you agree your contribution is licensed under the MIT License. Skill content inside skills/ retains its upstream license — see LICENSE for the note on bundled content.