Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
199 lines (131 loc) · 5.46 KB

CONTRIBUTING.md

File metadata and controls

199 lines (131 loc) · 5.46 KB

Contributing to TRAE Community

Welcome to TRAE Community! We're excited to have you contribute! 🎉

This guide provides general contribution guidelines for all repositories in the TRAE Community organization. Each individual repository may have its own specific CONTRIBUTING.md file with additional details.

📋 Table of Contents

Code of Conduct

Please read and follow our Code of Conduct to maintain a welcoming and inclusive community.

Getting Started

1. Choose Your Path

Depending on your interests and experience, you can:

  • 👀 Explorer: Browse repositories and learn from existing code
  • 📖 Learner: Follow structured learning paths and build projects
  • 🔨 Builder: Contribute to active projects
  • 💡 Innovator: Start new initiatives or create templates

2. Find Your Project

Check out our organization page to explore all repositories:

3. Read Repository-Specific Guidelines

Each project has its own contribution guidelines. Always check the CONTRIBUTING.md file in the specific repository you want to contribute to.

How to Contribute

We welcome contributions of all kinds! Here are some ways you can help:

💻 Code Contributions

  • Fix bugs
  • Add new features
  • Improve performance
  • Write tests

📝 Documentation

  • Fix typos
  • Clarify explanations
  • Add examples
  • Translate content

🎨 Design & UX

  • Improve UI/UX
  • Create graphics or diagrams
  • Suggest design improvements

💬 Community Support

  • Answer questions in discussions
  • Help review pull requests
  • Welcome new contributors
  • Share your projects

Development Workflow

Step 1: Fork the Repository

Click the "Fork" button at the top right of the repository page to create your own copy.

Step 2: Clone Your Fork

git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
cd REPOSITORY_NAME

Step 3: Create a Branch

git checkout -b feature/your-feature-name

Use descriptive branch names like:

  • fix/login-bug
  • feat/add-dark-mode
  • docs/update-readme

Step 4: Make Changes

Make your changes following the repository's coding standards. Remember to:

  • Write clean, readable code
  • Add comments where necessary
  • Update documentation if needed
  • Test your changes

Step 5: Commit Your Changes

git add .
git commit -m "feat: add new feature description"

Follow Conventional Commits for clear commit messages.

Step 6: Push to Your Fork

git push origin feature/your-feature-name

Step 7: Create a Pull Request

  1. Go to the original repository
  2. Click "Pull requests" → "New pull request"
  3. Select your fork and branch
  4. Fill in the PR template
  5. Submit!

Pull Request Guidelines

Before Submitting

  • ✅ Ensure your code follows the project's style guidelines
  • ✅ Write or update tests as needed
  • ✅ Update documentation if applicable
  • ✅ Run all tests and ensure they pass
  • ✅ Check for linting errors

PR Description Template

When creating a PR, please include:

## Description
Brief description of what this PR does

## Related Issues
Link any related issues (e.g., "Fixes #123")

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Testing
Describe how you tested these changes

## Checklist
- [ ] I have read the contributing guidelines
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings
- [ ] I have updated tests as needed
- [ ] All tests pass locally

Questions?

Need help or have questions? Join our community discussions!

  • 💬 trae-discussions - Ask questions, share ideas, and connect with other contributors
  • 📚 trae-learning - Learn more about TRAE and AI-native development

Thank You!

Every contribution makes TRAE Community better. Whether it's fixing a typo, adding a feature, or starting a new project, your work helps us all grow.

Built with 🤖 by humans who believe in AI collaboration

Note: This is the organization-level contribution guide. Always refer to repository-specific CONTRIBUTING.md files for detailed guidelines related to individual projects.