From d5d7667ded9199c167ee20232281454d2d667d64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nathan=20=F0=9F=94=B6=20Tarbert?= <66887028+NathanTarbert@users.noreply.github.com> Date: Wed, 16 Jul 2025 14:48:06 -0400 Subject: [PATCH 1/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 63 ++++++++++++++++++++----------------------------- 1 file changed, 26 insertions(+), 37 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e9d1d6b8..7044b5359 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,57 +1,46 @@ # Contributing to AG-UI -Thanks for your interest in improving **AG-UI**! - -This short guide shows the fastest way to get your idea merged. -You can find more detailed contribution guides at [ag-ui.com](ag-ui.com) +Thanks for your interest in contributing to AG-UI! Here's how to get started—whether you're reporting issues, submitting code, or just exploring. --- -## 1. Start a Discussion - -Before writing code, open a new **Discussion** and briefly cover: +## 🙋‍♂️ Have a Question or Issue? -1. **Problem** – what you’re trying to solve. -2. **Proposal** – how you plan to solve it (code, docs, design, etc.). -3. **Alternatives** – other options you considered. +Choose the right channel so we can respond efficiently: -Early feedback keeps everyone aligned and saves re-work. +- **🐛 Bugs / 🔧 Feature Requests**: [Open a GitHub Issue](https://github.com/ag-ui-protocol/ag-ui/issues) +- **❓ Technical Questions / How-Tos**: [Use GitHub Discussions](https://github.com/ag-ui-protocol/ag-ui/discussions) +- **💬 Informal Questions or Chat**: [Join our Discord]([](https://discord.gg/Jd3FzfdJa8)) and post in `#-💎-contributing` --- -## 2. Join a Bi-Weekly Working Group - -Meet the team and potential collaborators in our [bi-weekly community call](https://lu.ma/calendar/manage/cal-DBw2gK428IQbiSO). - ---- +## 🛠 Want to Contribute Code? -## 3. Connect with the Maintainers +1. **Find an Issue** + Browse open issues on [GitHub](https://github.com/ag-ui-protocol/ag-ui/issues) and find something you’re interested in. -Need a quick sync? +2. **Get Assigned** + Comment on the issue and tag a code owner to request assignment: + → [Code Owners List](https://github.com/ag-ui-protocol/ag-ui/blob/main/.github/CODEOWNERS) -- **Markus:** [@mme_xyz](https://twitter.com/mme_xyz) on X (Twitter) -- **Book a chat:** +3. **Approval & Roadmap** + Once approved, you’ll be assigned to the issue and it will be added to our [public roadmap](https://github.com/orgs/ag-ui-protocol/projects/1). ---- +4. **Coordinate** + - Use Discord to communicate with others working on the same thing. + - Create a thread in `#contributing` or DM the assignee if needed. -## 4. Useful Resources & Docs +5. **Submit a Pull Request** + - Make sure your PR includes a comment in the description: + `Fixes #` + - This auto-links the PR to the issue and marks it for closure. -| Resource | Link | -| ----------------------------------------- | -------------------------------------------------------- | -| Learn how to connect to AG-UI with JS | | -| Learn how to connect to AG-UI with Python | | -| Dojo reference implementation | | +6. **Code Review & Merge** + - A maintainer will review the PR and give feedback if needed. + - Once approved, your contribution will be merged and marked as "done." --- -## 5. Open Your Pull Request - -1. **Fork** the repo and create a feature branch. -2. Keep changes focused—one PR per feature or fix. -3. Link back to your Discussion in the PR description. - -We review PRs weekly. Feel free to nudge us in your Discussion if you haven’t heard back in a few days. - ---- +## ❤️ Thank You -**Thank you for making AG-UI better!** +We appreciate every contributor who helps make AG-UI better. Whether you're here to fix a bug, build a feature, or just ask a good question—you’re part of the project. From 49ca51e3ba9c5b48862e936919958eb9517bd4be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nathan=20=F0=9F=94=B6=20Tarbert?= <66887028+NathanTarbert@users.noreply.github.com> Date: Wed, 16 Jul 2025 15:17:47 -0400 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 79 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 52 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7044b5359..9c3000fcc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,46 +1,71 @@ -# Contributing to AG-UI +# 👋 Contributing to AG-UI -Thanks for your interest in contributing to AG-UI! Here's how to get started—whether you're reporting issues, submitting code, or just exploring. +Thanks for checking out AG-UI! Whether you’re here to fix a bug, ship a feature, improve the docs, or just figure out how things work—we’re glad you’re here. + +Here’s how to get involved: + +--- + +## 🤔 Have a Question or Ran Into Something? + +Pick the right spot so we can help you faster: + +- **🐛 Bugs / Feature Ideas** → [GitHub Issues](https://github.com/ag-ui-protocol/ag-ui/issues) +- **❓ "How do I...?" / General Questions** → [GitHub Discussions](https://github.com/ag-ui-protocol/ag-ui/discussions) +- **💬 Quick chats / casual stuff** → [Discord](https://discord.gg/Jd3FzfdJa8) → `#-💎-contributing` --- -## 🙋‍♂️ Have a Question or Issue? +## 🧑‍💻 Want to Contribute Code? + +1. **Find Something to Work On** + Browse open issues on [GitHub](https://github.com/ag-ui-protocol/ag-ui/issues). + Got your own idea? Open an issue first so we can start the discussion. + +2. **Ask to Be Assigned** + Comment on the issue and tag a code owner: + → [Code Owners](https://github.com/ag-ui-protocol/ag-ui/blob/main/.github/CODEOWNERS) + +3. **Get on the Roadmap** + Once approved, you'll be assigned the issue, and it'll get added to our [roadmap](https://github.com/orgs/ag-ui-protocol/projects/1). + +4. **Coordinate With Others** + - If you're collaborating or need feedback, start a thread in `#-💎-contributing` on Discord + - Or just DM the assignee directly -Choose the right channel so we can respond efficiently: +5. **Open a Pull Request** + - When you’re ready, submit your PR + - In the description, include: `Fixes #` + (This links your PR to the issue and closes it automatically) -- **🐛 Bugs / 🔧 Feature Requests**: [Open a GitHub Issue](https://github.com/ag-ui-protocol/ag-ui/issues) -- **❓ Technical Questions / How-Tos**: [Use GitHub Discussions](https://github.com/ag-ui-protocol/ag-ui/discussions) -- **💬 Informal Questions or Chat**: [Join our Discord]([](https://discord.gg/Jd3FzfdJa8)) and post in `#-💎-contributing` +6. **Review & Merge** + - A maintainer will review your code and leave comments if needed + - Once it’s approved, we’ll merge it and move the issue to “done.” --- -## 🛠 Want to Contribute Code? +## 📝 Want to Contribute to the Docs? -1. **Find an Issue** - Browse open issues on [GitHub](https://github.com/ag-ui-protocol/ag-ui/issues) and find something you’re interested in. +Docs are part of the codebase and super valuable—thanks for helping improve them! -2. **Get Assigned** - Comment on the issue and tag a code owner to request assignment: - → [Code Owners List](https://github.com/ag-ui-protocol/ag-ui/blob/main/.github/CODEOWNERS) +Here’s how to contribute: -3. **Approval & Roadmap** - Once approved, you’ll be assigned to the issue and it will be added to our [public roadmap](https://github.com/orgs/ag-ui-protocol/projects/1). +1. **Open an Issue First** + - Open a [GitHub issue](https://github.com/ag-ui-protocol/ag-ui/issues) describing what you’d like to update or add. + - Then comment and ask to be assigned. -4. **Coordinate** - - Use Discord to communicate with others working on the same thing. - - Create a thread in `#contributing` or DM the assignee if needed. +2. **Submit a PR** + - Once assigned, make your edits and open a pull request. + - In the description, include: `Fixes #` + (This links your PR to the issue and closes it automatically) -5. **Submit a Pull Request** - - Make sure your PR includes a comment in the description: - `Fixes #` - - This auto-links the PR to the issue and marks it for closure. + - A maintainer will review it and merge if it looks good. -6. **Code Review & Merge** - - A maintainer will review the PR and give feedback if needed. - - Once approved, your contribution will be merged and marked as "done." +That’s it! Simple and appreciated. --- -## ❤️ Thank You +## 🙌 That’s It! -We appreciate every contributor who helps make AG-UI better. Whether you're here to fix a bug, build a feature, or just ask a good question—you’re part of the project. +AG-UI is community-built, and every contribution helps shape where we go next. +Big thanks for being part of it!