Skip to content

feat: add CONTRIBUTING.md and structural PR validation CI#62

Open
sendtoshailesh wants to merge 1 commit intomainfrom
feat/contributing-and-pr-validation
Open

feat: add CONTRIBUTING.md and structural PR validation CI#62
sendtoshailesh wants to merge 1 commit intomainfrom
feat/contributing-and-pr-validation

Conversation

@sendtoshailesh
Copy link
Copy Markdown
Contributor

Summary

Closes #17.

Adds a contributor guide and a structural PR validation pipeline so community skill contributions can be verified automatically.

This is a re-scoped replacement for #40, which mixed three concerns. The exploratory eval framework portion has been split into #61 and intentionally excluded from this PR.

Changes

  • CONTRIBUTING.md — skill contribution guide (directory structure, SKILL.md frontmatter schema, naming conventions), maintainer-curated agent change process, PR process, and a link to the Microsoft Open Source Code of Conduct.
  • .github/workflows/pr-validation.yml — active workflow on every PR to main:
    • structure-check job runs scripts/validate-structure.js.
    • markdownlint job runs across *.md (excluding website/node_modules, website/build, website/docs).
  • scripts/validate-structure.js — checks frontmatter required fields, name-directory consistency, kebab-case directory naming, SKILL.md presence, required sections (## When to Use, ## Procedure; ## Warning for agents), agent/skill cross-reference integrity, and relative-link resolution.
  • .markdownlint.json — shared lint config.

All checks pass against the current repo state.

What is not in this PR

The Agent/Skill eval framework (originally section 3 of #17) is tracked separately in #61 and is intentionally out of scope here. The earlier spike under evals/ from #40 is not carried over; #61 will revisit it from scratch.

Acceptance criteria mapping (#17, reduced scope)

  • CONTRIBUTING.md exists with clear skill contribution guidelines and SKILL.md schema.
  • Code of Conduct linked (Microsoft OSS standard).
  • PR validation workflow runs on every PR (active .yml, not .example.yml).
  • Frontmatter, naming, cross-reference, and section checks all pass on the current repo.

Notes for reviewers

Related

Implements scope of #17 (de-scoped):

- CONTRIBUTING.md: skill contribution guide, SKILL.md schema, PR process, Code of Conduct link

- .github/workflows/pr-validation.yml: structural validation + markdownlint on every PR

- scripts/validate-structure.js: frontmatter, naming, cross-reference, link, and section checks

- .markdownlint.json: shared lint config

The eval framework (originally section 3 of #17) is split out to #61 and is not part of this PR.

Supersedes #40.
@sendtoshailesh sendtoshailesh requested a review from arnaudlh May 6, 2026 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CONTRIBUTING.md and contribution verification CI

1 participant