Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
255 lines (197 loc) · 6 KB

CONTRIBUTING.md

File metadata and controls

255 lines (197 loc) · 6 KB

Contribution Guidelines

Welcome to contribute to Awesome TRAE! We appreciate your submissions and help in building a comprehensive collection of amazing TRAE projects and resources.

Awesome TRAE Banner

English | 中文

📋 What We're Looking For

We accept high-quality projects, tools, tutorials, and resources related to TRAE. Your submission should:

✅ Must Have

  • TRAE Related: Must use or relate to TRAE
  • Accessible: Public repository, live demo, or accessible resource
  • Quality: Well-crafted and functional
  • Documented: Basic documentation or description provided

🎯 Nice to Have

  • Innovative or unique use of TRAE
  • High completion level
  • Active maintenance
  • Community engagement
  • Clear examples or demos

🚀 How to Submit

Step 1: Choose Category

Select the most appropriate category for your submission:

  • 🚀 Projects - Complete applications or demos
  • 🤖 Agents - Custom agent configurations
  • 🔧 Tools - Utilities and extensions
  • 📚 Tutorials - Educational content
  • 📦 Templates - Project starters
  • 🎓 Resources - Learning materials

Step 2: Prepare Information

Gather the following details:

  • Project/resource name
  • URL (GitHub repo, website, etc.)
  • Brief description (1-2 sentences)
  • Key features or highlights
  • Screenshots or demos (if applicable)

Step 3: Create an Issue

  1. Go to Issues
  2. Click "New Issue"
  3. Select the appropriate template
  4. Fill in all required fields

Step 4: Wait for Review

  • Acknowledgment: Within 24 hours
  • Review: 3-5 business days
  • Inclusion: Once approved, added to our collection!

👉 For detailed guidelines, see the sections below.

📝 Submission Types

🚀 Projects & Demos

What to include:

  • Project name and description
  • Repository URL
  • Live demo URL (if available)
  • Tech stack used
  • Key features
  • Screenshots or GIFs

Example:

**Name**: TaskMaster Pro
**URL**: https://github.com/user/taskmaster
**Demo**: https://taskmaster.demo.com
**Description**: A powerful task management app built with TRAE
**Features**: 
- AI-powered task prioritization
- Smart scheduling
- Team collaboration

🤖 Custom Agents

What to include:

  • Agent name and purpose
  • Configuration details
  • Usage examples
  • Installation instructions
  • Compatible TRAE versions

Example:

**Name**: Code Review Assistant
**Purpose**: Automated code review and suggestions
**Configuration**: [Link to config]
**Examples**: [Usage examples]

🔧 Tools & Extensions

What to include:

  • Tool name and function
  • Installation guide
  • Usage documentation
  • Compatibility information
  • Feature list

Example:

**Name**: TRAE Snippet Manager
**Function**: Manage and organize code snippets
**Install**: npm install trae-snippets
**Features**: 
- Quick snippet search
- Category organization
- Cloud sync

📚 Tutorials & Guides

What to include:

  • Tutorial title and objective
  • Target audience level (beginner/intermediate/advanced)
  • Prerequisites
  • Step-by-step content
  • Expected outcomes

Example:

**Title**: Building Your First TRAE App
**Level**: Beginner
**Duration**: 30 minutes
**Prerequisites**: Basic JavaScript knowledge
**Content**: [Link to tutorial]

📦 Templates

What to include:

  • Template name and purpose
  • Included files structure
  • Getting started guide
  • Customization options
  • Example usage

Example:

**Name**: React + TRAE Starter
**Includes**: Component templates, config files
**Quick Start**: [Setup guide]
**Customization**: [Options guide]

🎓 Learning Resources

What to include:

  • Resource name and type
  • Provider or author
  • Access information (free/paid)
  • Content overview
  • Recommended path

Example:

**Name**: TRAE Masterclass
**Type**: Video Course
**Provider**: Tech Academy
**Access**: Free
**Content**: 10 hours of video tutorials

🎯 Quality Standards

Documentation

  • Clear and concise descriptions
  • Proper formatting and grammar
  • Helpful examples
  • Contact or support information

Functionality

  • Works as described
  • No major bugs or issues
  • Reasonably tested
  • Regular updates (for active projects)

TRAE Integration

  • Meaningful use of TRAE
  • Clear explanation of TRAE features used
  • Benefits from TRAE integration

🔍 Review Process

Timeline

  • Day 1: Acknowledgment
  • Days 2-5: Review and evaluation
  • Days 6-10: Feedback (if needed)
  • Day 10+: Final decision

Evaluation Criteria

Submissions are evaluated on:

  1. Relevance (30%): Connection to TRAE
  2. Quality (30%): Overall excellence
  3. Documentation (20%): Clarity and completeness
  4. Impact (20%): Usefulness to community

Outcomes

  • ✅ Approved: Added to collection
  • ⚠️ Needs Work: Minor changes requested
  • ❌ Declined: Doesn't meet criteria (with feedback)

💡 Tips for Success

Do's

✅ Provide clear, complete information ✅ Include working links and demos ✅ Write compelling descriptions ✅ Highlight what makes it awesome ✅ Respond to feedback promptly

Don'ts

❌ Submit incomplete information ❌ Include broken links ❌ Exaggerate TRAE usage ❌ Submit low-effort content ❌ Ignore review feedback

🤔 Common Questions

Q: Can I submit multiple items?

A: Yes! Each item should be submitted separately.

Q: Can I update my submission?

A: Absolutely! Just comment on your issue with updates.

Q: Is there a cost to submit?

A: No, it's completely free!

Q: Who owns the content?

A: You retain all rights. We just list it.

Q: Can I submit commercial products?

A: Yes, if they provide genuine value to the TRAE community.

🙏 Thank You!

Your contribution helps build a comprehensive resource for the TRAE community. Together, we're creating an invaluable collection of projects and resources!

Happy contributing! 🎉