magnus919_agent-skills/CONTRIBUTING.md

Contributing to agent-skills

Thanks for helping improve agent-skills. Contributions should make a skill more useful, more portable, or easier for humans and agents to discover.

Before you start

• Read AGENTS.md for repository-wide conventions.
• Read the target skill's SKILL.md and README.md before changing it.
• For a new skill or a substantial change, open an issue first so the scope can be discussed.
• Do not include credentials, private infrastructure details, or deployment-specific paths.

Skill requirements

Each skill must:

• Live in its own directory with a matching lowercase, hyphenated name.
• Include SKILL.md with valid YAML frontmatter.
• Include a human-facing README.md with the required sections described in AGENTS.md.
• Keep core instructions concise and put deeper material in references/, templates/, or scripts/.
• Use relative links that work from a fresh clone.
• Describe when the skill should be loaded, and identify the nearest alternative when overlap matters.

Development

Clone the repository and run the validator from its root:

git clone https://github.com/magnus919/agent-skills.git
cd agent-skills
ruby scripts/validate-skills.rb

The same validation runs in GitHub Actions for pushes and pull requests. If a skill includes executable scripts or a package, run its documented checks as well and include the commands and results in your pull request.

Pull requests

• Create a branch from main: feat/short-description, fix/short-description, or docs/short-description.
• Keep each pull request focused on one logical change.
• Use a clear Conventional Commit subject, such as feat(skill): add ... or fix(skill): ....
• Add or update documentation with the behavior it describes.
• Do not force-push after review unless a maintainer asks you to.
• Complete the pull request checklist and disclose meaningful AI assistance.

A maintainer may ask for an issue before reviewing a large design change. Small documentation fixes and clear bug fixes can go directly to a pull request.

License

By contributing, you agree that your contribution is released under the MIT License in this repository.