Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
117 lines (85 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

117 lines (85 loc) · 3.99 KB

Contributing to Awesome Specification Driven Development

Thank you for your interest in contributing to this awesome list! Your contributions help make this resource more valuable for the entire specification-driven development community.

How to Contribute

  1. Fork this repository
  2. Clone your fork locally
  3. Create a branch for your contribution
  4. Add your resource following the guidelines below
  5. Submit a pull request with a clear description

Guidelines for Adding Resources

General Criteria

  • Relevance: The resource must be directly related to specification-driven development, API-first design, contract testing, BDD, or related methodologies
  • Quality: Resources should be well-maintained, documented, and actively used by the community
  • Uniqueness: Avoid duplicates; check existing entries before adding
  • Open Source Preferred: While not required for learning resources, open source tools are preferred

Format Requirements

For GitHub Projects

**[Project Name](https://github.com/user/repo)** - Brief description of what the project does and its key features. ![GitHub stars](https://img.shields.io/github/stars/user/repo)

For Other Resources

**[Resource Name](https://example.com)** - Brief description of the resource and why it's valuable.

Section Guidelines

Popular Frameworks

  • Must be actively maintained
  • Should have significant community adoption
  • Include frameworks for OpenAPI, BDD, Contract Testing, etc.

Theory and Methodologies

  • Academic papers, books, or comprehensive guides
  • Core concepts and methodologies
  • Historical or foundational resources

Agentic Programming

  • Tools and frameworks for building AI agents
  • Specification-driven agent development
  • Multi-agent systems and frameworks

MCP Servers

  • Model Context Protocol server implementations
  • Tools that work with MCP
  • Registries and collections

IDE Support

  • Extensions, plugins, and tools for popular IDEs
  • Language servers for specifications
  • Development environment integrations

Blog Posts

  • High-quality technical articles
  • Tutorials and how-to guides
  • Industry insights and best practices

Community

  • Forums, discussion groups, and communities
  • Conferences and events
  • Professional networks

Pull Request Process

  1. Check for duplicates - Search existing entries to avoid duplicates
  2. Add to appropriate section - Place your entry in the most relevant section
  3. Maintain alphabetical order - Within each section, keep entries sorted alphabetically
  4. Write clear descriptions - Keep descriptions concise but informative
  5. Test links - Ensure all links work correctly
  6. Update table of contents - If adding new sections, update the TOC

Quality Standards

Descriptions

  • Use present tense
  • Be concise but informative
  • Highlight key features or benefits
  • Avoid marketing language

Links

  • Use HTTPS when available
  • Link to the primary/official source
  • For GitHub projects, link to the main repository

What Not to Include

  • Commercial products without free tiers (exceptions for exceptional learning resources)
  • Abandoned projects (no activity for 2+ years)
  • Duplicate tools that serve the same purpose as existing entries
  • Low-quality or incomplete resources
  • Self-promotional content without clear community value

Getting Help

If you're unsure about whether a resource fits or need help with formatting:

  1. Open an issue to discuss before submitting a PR
  2. Look at existing entries for formatting examples
  3. Ask questions in your pull request description

Code of Conduct

Please be respectful and constructive in all interactions. This project follows the principles of open source collaboration and welcomes contributors from all backgrounds.

Recognition

All contributors will be acknowledged. Your GitHub profile will be linked in the contributors section if your PR is merged.

Thank you for helping make this resource awesome! 🚀