Contributing to Swift API Design Guidelines Skill

Thanks for your interest in improving this skill. Contributions that make Swift API design guidance clearer, more accurate, and more up to date are welcome.

About Agent Skills

Agent Skills are structured prompt assets with:

• A SKILL.md file that defines behavior and checklists
• Reference files that provide focused guidance for specific topics

Recommended Workflow (Skill Creator)

If you use the skill-creator skill, you can:

• Propose changes in plain language
• Have the skill generate or refine SKILL.md and reference content
• Review for API-design guideline accuracy and consistency

Alternative Workflows

Claude without skill-creator

• Make changes directly in swift-api-design-guidelines-skill/SKILL.md or swift-api-design-guidelines-skill/references/
• Keep content concise and focused on Swift API design guidelines

Manual edits

• Edit Markdown files directly
• Ensure headings and checklists stay consistent

Types of Contributions

• Fix incorrect API-design guidance
• Add missing guideline coverage or clarifications
• Improve clarity in workflows and checklists
• Expand reference files with focused API naming/labeling examples
• Improve documentation in README.md or this guide

Quality Standards

• Swift API design content only
• Avoid architecture mandates or project-structure requirements
• Avoid tooling instructions beyond basic git usage
• Favor clarity at the point of use and guideline-consistent naming
• Prefer clear, direct language over opinionated phrasing

Pull Request Process

1. Fork the repo (or branch if you have access).
2. Make changes in a focused scope.
3. Ensure swift-api-design-guidelines-skill/SKILL.md and references remain consistent.
4. Open a PR with a short summary and test notes.

Development Setup

• Standard Markdown editing is sufficient.
• If you add or rename reference files, keep the README structure block in sync (or rely on the sync workflow once enabled).

Resources

• Agent Skills documentation: https://docs.anthropic.com/en/docs/claude-code/agent-skills
• Swift API Design Guidelines: https://www.swift.org/documentation/api-design-guidelines/

Code of Conduct

Be respectful and constructive. Assume positive intent and focus on improving the quality of API design guidance.