Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (47 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 2.39 KB

Contributing to Stream Coding

Thank you for your interest in contributing to Stream Coding! This project follows the very methodology it teaches — documentation-first development.

How to Contribute

Reporting Issues

  • Use GitHub Issues to report bugs or suggest features
  • Check existing issues before creating a new one
  • Use the provided issue templates

Proposing Changes

  1. Fork the repository
  2. Create a branch from main (git checkout -b feat/your-feature)
  3. Follow the methodology — if you're adding a skill, it must include a SKILL.md with proper frontmatter
  4. Test your changes — run verify.py if applicable
  5. Submit a PR using the pull request template

What We Accept

Contribution Type Welcome? Notes
New skills ✅ Yes Must follow skill structure (see skill-creator skill)
Skill improvements ✅ Yes Include evidence of improvement (before/after)
Bug fixes ✅ Yes Include reproduction steps
Documentation fixes ✅ Yes Typos, clarity, broken links
Methodology changes ⚠️ Discuss first Open an issue to discuss before implementing
New gate/workflow ⚠️ Discuss first Must prove it's load-bearing, not just "nice to have"

What We Don't Accept

  • Skills without SKILL.md frontmatter
  • Methodology additions that aren't proven load-bearing (see /methodology-review)
  • Changes that break existing gate scripts
  • AI-generated PRs without human review

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold this code.

Style Guide

Skills

  • Every skill must have a SKILL.md with YAML frontmatter (name, description)
  • Descriptions must be under 200 characters and YAML-safe (no colons, quotes, or special characters)
  • Scripts go in a scripts/ subdirectory
  • Follow existing skill structure as reference

Documentation

  • Use standard Markdown
  • Keep lines concise
  • Use tables for structured information
  • Include anti-patterns where applicable

Commits

<type>(<scope>): <short description>

Allowed types: feat, fix, docs, refactor, test, chore, perf, ci, improve, learn

Questions?

Open a Discussion or an issue. We're happy to help.