diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..abc9304 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,90 @@ +# Contributing to skill-jam + +Thanks for your interest in improving `skill-jam`. Contributions help keep the repository useful for developers, researchers, and AI builders working with agent skills. + +This project follows the standard GitHub contributor workflow: keep changes focused, use a clear pull request description, and make it easy for maintainers to review your work. + +## Ways to contribute + +You can help by: + +- reporting bugs or broken skill instructions +- improving documentation and examples +- adding or refining skills in `skills/` or `featured-skills/` +- suggesting a new submodule or reference collection +- improving project tooling, structure, or metadata + +## Before you start + +1. Fork the repository and create a feature branch from `main`. +2. Keep each change scoped to a single concern. +3. Sync your fork with the latest upstream changes before opening a pull request. +4. If your work is still in progress, open a draft pull request and update it as you go. + +## Recommended workflow + +```bash +git checkout main +git pull upstream main +git checkout -b fix/my-change +# make updates +# validate as needed +git add . +git commit -m "fix: describe the change" +git push origin fix/my-change +``` + +Use clear branch names such as: + +- `fix/readme-badge-counts` +- `feat/add-new-skill` +- `docs/improve-contributing-guide` + +## Pull request expectations + +When you open a pull request: + +- write a descriptive title and summary +- explain the reason for the change and the impact +- keep the diff focused and easy to review +- link the related issue if one exists +- include validation notes or examples of how you checked the change + +For upstream repository changes, maintainers may choose the merge strategy that best fits the repo. Keep the PR ready for review and respond to comments in a timely, constructive way. + +## Skill contributions + +If you are adding a skill, follow the repository conventions in [`docs/contributing.md`](docs/contributing.md) and the skill format described in the project README. + +At minimum, a skill should: + +- have a clear, single responsibility +- use a descriptive kebab-case directory name +- include a `SKILL.md` file with the required sections +- provide example input/output details and dependencies +- be broadly useful and not narrow to a single niche use case + +## Documentation updates + +Documentation fixes are welcome and often the easiest way to contribute. If you update README files, examples, or contributor guidance, keep the content clear, accurate, and consistent with the rest of the repo. + +## Reporting issues + +Open a GitHub issue with: + +- a clear title +- the expected behavior versus the current behavior +- reproduction steps when relevant +- environment details such as OS, Node version, or tool version +- the affected skill or file path + +## Code of conduct + +Please be respectful, constructive, and inclusive. We value thoughtful collaboration and encourage contributors to engage kindly and professionally. + +For more project-specific guidance, see: + +- [`README.md`](README.md) +- [`docs/contributing.md`](docs/contributing.md) +- [GitHub Docs: Setting guidelines for repository contributors](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors) +- [GitHub Docs: About pull requests](https://docs.github.com/en/pull-requests) diff --git a/README.md b/README.md index c84e8a7..34d8fc2 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@
- SKILL JAM v1.41 by VRIL LABS + SKILL JAM v1.42 by VRIL LABS
-![Version](https://img.shields.io/badge/version-v1.41-blueviolet?style=flat-square) +![Version](https://img.shields.io/badge/version-v1.42-blueviolet?style=flat-square) ![License](https://img.shields.io/badge/license-open%20source-green?style=flat-square) ![Stack](https://img.shields.io/badge/stack-Three.js%20%7C%20React%20Three%20Fiber%20%7C%20TSL-orange?style=flat-square) ![VRIL LABS Original Skills](https://img.shields.io/badge/VRIL%20LABS%20Original%20Skills-103-ff69b4?style=flat-square&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0id2hpdGUiIGQ9Ik0xMiAyQzYuNDggMiAyIDYuNDggMiAxMnM0LjQ4IDEwIDEwIDEwIDEwLTQuNDggMTAtMTBTMTcuNTIgMiAxMiAyem0xIDE1aC0ydi02aDJ2NnptMC04aC0yVjdoMnYyeiIvPjwvc3ZnPg==) -![Featured 3D Skills](https://img.shields.io/badge/Featured%203D%20Skills-12-00bfff?style=flat-square) +![Featured 3D Skills](https://img.shields.io/badge/Featured%203D%20Skills-11-00bfff?style=flat-square) ![Total Submodules](https://img.shields.io/badge/Total%20Submodules-24-yellow?style=flat-square) ![Total Skills in Submodules](https://img.shields.io/badge/Total%20Skills%20in%20Submodules-2%2C000%2B-9b59b6?style=flat-square) ![Total Skills Jammed](https://img.shields.io/badge/Total%20Skills%20Jammed-2%2C100%2B-e74c3c?style=flat-square&logoColor=white) @@ -46,10 +46,10 @@ An **agent skill** is a discrete, callable capability that an AI agent can use a ``` skill-jam/ ├── README.md ← You are here -├── header.svg ← Animated banner (v1.41) +├── header.svg ← Animated banner (v1.42) ├── .claude-plugin/ │ └── marketplace.json ← Skills discovery config (enables npx skills add) -├── featured-skills/ ← 12 hand-picked skills for visual design and interactive systems +├── featured-skills/ ← 11 hand-picked skills for visual design and interactive systems │ ├── biefeld-brown-electrogravitics-visualizer/ │ ├── hutchison-effect-visualizer/ │ ├── leedskalnin-magnetic-current-visualizer/ @@ -112,7 +112,7 @@ skill-jam/ ## ⭐ Featured Skills -The `featured-skills/` directory showcases **12 hand-picked skills** for visual design and interactive systems, including **10 production-quality 3D visualizer skills** built on [Three.js r182+](https://threejs.org/), [React Three Fiber v9](https://docs.pmnd.rs/react-three-fiber), TSL/GLSL shaders, and GPU particle systems, plus the Paper Shaders guidance skill for paper-inspired shader and texture design. The 10 visualizer skills each bring an alternative-physics concept to life with interactive real-time 3D rendering. +The `featured-skills/` directory showcases **11 hand-picked skills** for visual design and interactive systems, including **10 production-quality 3D visualizer skills** built on [Three.js r182+](https://threejs.org/), [React Three Fiber v9](https://docs.pmnd.rs/react-three-fiber), TSL/GLSL shaders, and GPU particle systems, plus the Paper Shaders guidance skill for paper-inspired shader and texture design. The 10 visualizer skills each bring an alternative-physics concept to life with interactive real-time 3D rendering. | # | Skill | Description | |---|-------|-------------| @@ -167,9 +167,9 @@ npx skills add https://github.com/VRIL-LABS/skill-jam --skill paper-shaders npx skills add https://github.com/VRIL-LABS/skill-jam --skill tesla-standing-wave-visualizer ``` -### Install all 62 skills (general + featured visualizers) +### Install all 61 skills (general + featured visualizers) -The `featured-skills/` directory lives one level deeper than Vercel's flat layout, so a `.claude-plugin/marketplace.json` is included at the repository root to make all 12 featured skills discoverable at the same depth as the general skills. No extra flags are needed: +The `featured-skills/` directory lives one level deeper than Vercel's flat layout, so a `.claude-plugin/marketplace.json` is included at the repository root to make all 11 featured skills discoverable at the same depth as the general skills. No extra flags are needed: ```bash npx skills add https://github.com/VRIL-LABS/skill-jam --skill "*" @@ -411,12 +411,13 @@ Production-grade web design and development skills built exclusively by VRIL LAB ## 🤝 Contributing -Have a skill you'd like to add? We'd love to include it! Please see [`docs/contributing.md`](docs/contributing.md) for guidelines on how to structure and submit a new skill. +We welcome bug reports, documentation improvements, and new skill submissions. Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) before opening an issue or pull request so the workflow stays consistent with GitHub contributor guidelines. -A few ground rules: -- Each skill should have a **clear, single responsibility** -- Include a description, example inputs/outputs, and any dependencies -- Skills should be broadly useful, not narrowly specific to one use-case +For skill authoring and repository conventions, see [`docs/contributing.md`](docs/contributing.md). We expect contributions to be: +- Focused and easy to review +- Backed by clear context or examples when behavior changes +- Respectful, constructive, and aligned with the project goals +- Designed around a single, reusable responsibility for each skill --- diff --git a/header.svg b/header.svg index 3e8a877..3a0f319 100644 --- a/header.svg +++ b/header.svg @@ -109,7 +109,7 @@ - v1.41 + v1.42