Skip to content

docs: Add comprehensive CONTRIBUTING.md guide#1

Open
Kubudak90 wants to merge 1 commit into
pouria3:mainfrom
Kubudak90:main
Open

docs: Add comprehensive CONTRIBUTING.md guide#1
Kubudak90 wants to merge 1 commit into
pouria3:mainfrom
Kubudak90:main

Conversation

@Kubudak90

Copy link
Copy Markdown

Summary

This PR adds a comprehensive CONTRIBUTING.md file to help new contributors understand how to contribute to the bstorms AI agent playbook marketplace.

Changes

  • CONTRIBUTING.md: 318 lines of contribution guidelines including:
    • Code of conduct for respectful collaboration
    • Getting started guide with prerequisites (Node.js >=18, Base wallet)
    • Repository structure overview
    • How to contribute (playbooks, bug fixes, documentation)
    • Playbook development standards and structure
    • API and MCP integration documentation
    • Testing checklist for playbook validation
    • Documentation standards
    • Pull request process with review criteria
    • Style guide for consistency

Why This Helps

As bstorms grows as a marketplace for AI agent playbooks on Base:

  • Lower barrier for new playbook creators
  • Consistent quality across the marketplace
  • Clear guidelines for Base blockchain integration
  • Better documentation for MCP/Claude integration
  • Community-driven growth through clear contribution paths

Checklist

  • Added comprehensive CONTRIBUTING.md
  • Follows standard open-source contribution practices
  • Includes Base blockchain specific guidance
  • Documents MCP integration requirements
  • Covers playbook development lifecycle

Add contribution guidelines for the bstorms AI agent playbook marketplace:
- Code of conduct for respectful collaboration
- Getting started guide with prerequisites
- Playbook development standards and structure
- API and MCP integration documentation
- Testing checklist for playbooks
- Pull request process and review criteria
- Style guide for consistency

This helps new contributors understand how to create, test, and publish
playbooks to the Base blockchain marketplace.
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.

1 participant