Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

29 lines (21 loc) · 1.25 KB

Contributing

Thanks for helping. The most valuable contribution is a correction or addition backed by a source.

What makes a good change

  • Cite it. New claims need a source or a dated observation, and one of the three labels (verified, observed, general) described in skills/github-seo/SKILL.md.
  • Date it. Registry flows, subreddit rules and gallery requirements change. Include the date you checked.
  • Keep it short. The skill should stay easy for a model to follow. Move depth into references/.
  • No client data. Never include names, domains or details from private projects.

Workflow

  1. Fork and branch from main.

  2. Make the change.

  3. CI checks the skill frontmatter, the evals, the manifests and the internal links on each pull request. To run the same check before you push:

    sed -n '/<<.EOF./,/^ *EOF$/p' .github/workflows/ci.yml | sed '1d;$d' | sed 's/^          //' | python3 -
  4. If you changed when the skill should trigger, update skills/github-seo/evals/evals.json.

  5. Add a line to CHANGELOG.md under an Unreleased heading.

  6. Open a pull request and fill in the template.

Reporting a wrong claim

Open an issue using the bug report template and link the source that contradicts the skill.