Skip to content

Latest commit

 

History

History
287 lines (203 loc) · 8.23 KB

DISCORD_ANNOUNCEMENT.md

File metadata and controls

287 lines (203 loc) · 8.23 KB

Discord Announcement - Copy-Paste Ready

Short Version (Quick Ping)

🎨 **terminal-ui is live!**

Need practice with PRs? Want to contribute to open source? 

I just launched **terminal-ui** - a React component library with 12 beginner-friendly issues ready to go.

Perfect for:
- Learning React/Next.js
- Practicing the PR workflow  
- Testing code-flow (our maintainer console)

**Easy first PRs:**
- Add a color theme (5 min) 🎨
- Create a progress bar component (15 min) 📊
- Add JSDoc comments (10 min) 📚

👉 https://github.com/OpenKnots/terminal-ui/issues?q=is%3Aissue+is%3Aopen+label%3A%22good-first-issue%22

Claim an issue and let's get your first PR merged! 🚀

Medium Version (Full Context)

🖥️ **New Project: terminal-ui** 

Hey everyone! I just launched a new open source project perfect for beginners:

**What is it?**
React components for building CLI-style UIs in the browser. Think terminal windows, command prompts, progress bars - all the retro aesthetic we love from OpenClaw! ✨

**Why should I care?**
- 🎯 12 good-first-issues ready to claim
- ⚡ Issues range from 5-30 minutes  
- 🎓 Learn React, TypeScript, Next.js
- 🤝 Practice the GitHub PR workflow
- 🎨 Build something cool together

**Quick Start (literally 3 steps):**
1. Browse issues: https://github.com/OpenKnots/terminal-ui/issues
2. Comment "I'd like to work on this!"  
3. Fork, code, PR - done! 

**Easy Wins:**
- 🎨 **Add Dracula theme** (5 min) - Just copy-paste CSS colors
- 📊 **Create TerminalProgress** (15 min) - Build a progress bar component
- 🐛 **Fix mobile scrolling** (20 min) - CSS debugging  
- 📚 **Add JSDoc comments** (10 min) - Write documentation

**Repo:** https://github.com/OpenKnots/terminal-ui
**Issues:** https://github.com/OpenKnots/terminal-ui/issues
**Live Playground:** (coming soon after first deploy!)

This is also a great way to test **code-flow** (our maintainer dashboard). Maintainers: add `OpenKnots/terminal-ui` to your filters and practice reviewing PRs! 

Drop a 🎉 if you're planning to contribute!

Long Version (With Examples & Screenshots)

🚀 **Introducing: terminal-ui** 

A new OpenKnots project designed for learning and contribution!

━━━━━━━━━━━━━━━━━━━━━━━━━━━━
## 🖥️ What is terminal-ui?

A React component library for building terminal-style UIs:

```tsx
<Terminal title="my-app" prompt="user@demo">
  <TerminalCommand>pnpm install</TerminalCommand>
  <TerminalOutput type="success">✓ Done!</TerminalOutput>
</Terminal>

Use cases:

  • AI agent interfaces (like OpenClaw!)
  • Interactive CLI tutorials
  • Developer dashboards
  • Retro-futuristic web apps

━━━━━━━━━━━━━━━━━━━━━━━━━━━━

🎯 Why Contribute?

For Beginners:

  • ✅ Issues labeled by difficulty (⭐ Easy, ⭐⭐ Medium, ⭐⭐⭐ Hard)
  • ✅ Clear acceptance criteria for each issue
  • ✅ Getting started guide in every issue
  • ✅ Friendly maintainer (me!) who responds fast

For Everyone:

  • 🎨 Build your portfolio with real OSS contributions
  • 📚 Learn modern React + Next.js + TypeScript
  • 🤝 Practice the PR review process
  • 🎉 Get recognized in the README

━━━━━━━━━━━━━━━━━━━━━━━━━━━━

🎨 Good First Issues (12 total)

Themes (⭐ Easy - 5 min each):

  • Add Dracula theme
  • Add Nord theme
  • Add Monokai theme
  • Add GitHub Dark theme

Components (⭐⭐ Medium - 15-30 min):

  • Create TerminalProgress (progress bars)
  • Create TerminalTree (file trees)
  • Create TerminalTable (data tables)

Docs (⭐ Easy - 10 min):

  • Add JSDoc comments to components
  • Add screenshots to README

Bugs (⭐⭐ Medium):

  • Fix mobile scrolling

Enhancements (⭐ Easy):

  • Add copy button to terminals

Advanced (⭐⭐⭐ for those who want a challenge):

  • Create TerminalPrompt (interactive input with history)

Full list: https://github.com/OpenKnots/terminal-ui/issues

━━━━━━━━━━━━━━━━━━━━━━━━━━━━

🚀 How to Get Started

1. Find an issue: https://github.com/OpenKnots/terminal-ui/issues?q=is%3Aissue+is%3Aopen+label%3A%22good-first-issue%22

2. Claim it: Comment: "I'd like to work on this!"

3. Fork & clone:

# Fork the repo on GitHub, then:
git clone https://github.com/YOUR_USERNAME/terminal-ui.git
cd terminal-ui
pnpm install
pnpm run dev

4. Make your changes:

5. Open a PR:

git checkout -b feat/your-feature
git add .
git commit -m "feat: add dracula theme"
git push origin feat/your-feature

Then open PR on GitHub!

6. Get it merged! 🎉

━━━━━━━━━━━━━━━━━━━━━━━━━━━━

📚 Resources

━━━━━━━━━━━━━━━━━━━━━━━━━━━━

🎮 Bonus: Test code-flow!

Maintainers: This repo is perfect for testing code-flow (our PR review dashboard).

  1. Add OpenKnots/terminal-ui to your repos
  2. Filter by good-first-issue label
  3. Watch PRs come in
  4. Practice using the new PR detail modal
  5. Approve/merge directly from code-flow

━━━━━━━━━━━━━━━━━━━━━━━━━━━━

🙋 FAQ

Q: I've never contributed to OSS before. Is this really beginner-friendly? A: Yes! Every issue has step-by-step instructions. If you get stuck, just ask!

Q: Do I need to know React? A: Basic JS/TS is enough for theme issues. Component issues are great for learning React!

Q: How long will PRs take to review? A: I'll aim for < 24 hours. Often same-day!

Q: Can I work on multiple issues? A: Yes! But please finish one before claiming another.

Q: What if someone is already working on the issue I want? A: Check the comments. If claimed > 7 days ago with no PR, it's fair game again!

━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Ready to contribute? Drop a 🚀 and claim your first issue!

Questions? Reply here or DM me!


---

## Super Quick Ping (For General Channel)

🎨 Got 5 minutes? Make your first open source PR!

Just launched terminal-ui with beginner-friendly issues: → https://github.com/OpenKnots/terminal-ui/issues

Add a color theme in < 5 min and get your PR merged today! 🚀


---

## Thread Reply Template (When Someone Shows Interest)

Awesome! Here's how to get started:

1️⃣ Pick an issue: https://github.com/OpenKnots/terminal-ui/issues?q=label%3A%22good-first-issue%22

2️⃣ Comment: "I'd like to work on this!" on the issue

3️⃣ Fork & code:

git clone https://github.com/YOUR_USERNAME/terminal-ui.git
cd terminal-ui && pnpm install && pnpm run dev

4️⃣ Follow the issue instructions (they're step-by-step!)

5️⃣ Open PR when done

Stuck? Reply here or in the issue - I'll help!

First timer? I recommend starting with a theme issue (Dracula, Nord, etc.) - literally just copy-paste CSS! 🎨


---

## Response to "Is this real or just busywork?"

Great question! This is a real project with real users:

Real use cases:

  • OpenClaw dashboard components
  • Interactive CLI tutorials
  • Developer tool UIs
  • Personal projects

Real learning:

  • Practice PR workflow (fork, branch, commit, PR)
  • Learn React component patterns
  • Get comfortable with TypeScript
  • Experience code review process

Real impact:

  • Your name in the README contributors section
  • Portfolio-worthy GitHub contributions
  • Experience you can mention in interviews

Not busywork:

  • No arbitrary "add semicolons" issues
  • Every component/theme will actually be used
  • Clear purpose: make CLI UIs accessible to web devs

Think of it as: A safe playground to learn OSS contribution before tackling complex projects like OpenClaw core!

Does that help? 😊