Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.78 KB

How to Contribute to the Agent Canvas Model

Thank you for your interest in improving the Agent Canvas. This is an open project, and community contributions are fundamental to the framework's evolution.

Ways to Contribute

1. Share Examples

If you've used the Agent Canvas to design an agent, share your experience:

  • Create a file in ejemplos/ following the format of existing examples
  • Don't include confidential information from your organization
  • Describe what worked, what didn't, and what you learned

2. Improve the Templates

  • Propose changes to existing blocks
  • Add new formats (Figma, Miro, Notion...)
  • Improve the visual design of the HTML templates

3. Translate

  • Translate the framework into other languages
  • Maintain terminological consistency with the Spanish original

4. Documentation

  • Expand the best practices guide
  • Add platform-specific guides (AWS, GCP, Azure, etc.)
  • Improve existing examples

How to Submit Your Contribution

  1. Fork the repository
  2. Create a branch with a descriptive name: feature/sales-agent-example or fix/readme-typo
  3. Make your changes
  4. Submit a Pull Request with a clear description of what you changed and why

Principles

  • Clarity over completeness: one well-explained block beats ten poorly defined ones
  • Platform-agnostic: the framework should work regardless of the technology stack
  • Practice-oriented: prioritize what helps real teams design better agents
  • Accessible: language should be understandable to both technical and business profiles

Reporting Issues

Use GitHub's Issues section to:

  • Report errors in the templates
  • Suggest improvements or new blocks
  • Propose changes to the methodology

Thank you for contributing. Every improvement helps more teams design better AI agents.