Skip to content

Latest commit

 

History

History
67 lines (37 loc) · 2.38 KB

File metadata and controls

67 lines (37 loc) · 2.38 KB

Contributing Guidelines

Welcome to contribute to TRAE Learning Projects! This repo collects learning resources about Vibecoding — your contribution will help many developers.

English | 中文


What You Can Contribute

New guide articles: The guide/ directory covers Vibecoding concepts and methodology. Currently there are 4 articles: What is Vibecoding, Flow & Efficiency, Prompt Engineering, and Best Practices. If you have insights worth sharing, submit a new article.

Hands-on tutorials: The tutorials/ directory collects practical content. A good tutorial has a clear goal, concrete steps, and code that actually runs. Existing tutorials cover beginner web projects through system design — new directions are welcome.

Content improvements: Fixes, additions, or translation improvements to existing articles — just open a PR.

Issue reports: Found broken links, incorrect info, or outdated content? Open an issue.


How to Submit

Small changes (fixes, translations, additions)

Fork → Edit → Open a PR. No need to discuss first.

New guides or tutorials

Open an issue first describing what you want to write. This helps avoid duplicate work and lets us share direction before you invest time writing.

In the issue, briefly cover:

  • What topic you want to write about
  • Target audience (beginner / intermediate / advanced)
  • Rough outline or structure

Content Requirements

Guide articles: Should have a clear point of view — not just a documentation rewrite. Length doesn't matter; value does.

Hands-on tutorials: Steps must work. Test the code yourself before submitting. Include difficulty level and estimated time.

General: Valid links, runnable code, no promotional content.


Bilingual

If you can, we welcome both Chinese and English versions. If you only write one language, that's fine — the community will help with translation.


Review Process

  • You'll get a response within 24 hours of submitting
  • Reviews are typically completed within 3-7 business days
  • If changes are needed, we'll leave comments on your PR/issue

Contact

Thanks for contributing!