|
| 1 | +# Contributing to AG-UI |
| 2 | + |
| 3 | +Thanks for your interest in improving **AG-UI**! |
| 4 | + |
| 5 | +This short guide shows the fastest way to get your idea merged. |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## 1. Start a Discussion |
| 10 | + |
| 11 | +Before writing code, open a new **Discussion** and briefly cover: |
| 12 | + |
| 13 | +1. **Problem** – what you’re trying to solve. |
| 14 | +2. **Proposal** – how you plan to solve it (code, docs, design, etc.). |
| 15 | +3. **Alternatives** – other options you considered. |
| 16 | + |
| 17 | +Early feedback keeps everyone aligned and saves re-work. |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## 2. Join a Bi-Weekly Working Group |
| 22 | + |
| 23 | +Meet the team and potential collaborators in our [bi-weekly community call](https://lu.ma/calendar/manage/cal-DBw2gK428IQbiSO). |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +## 3. Connect with the Maintainers |
| 28 | + |
| 29 | +Need a quick sync? |
| 30 | + |
| 31 | +- **Markus:** [@mme_xyz](https://twitter.com/mme_xyz) on X (Twitter) |
| 32 | +- **Book a chat:** <https://calendly.com/markus-copilotkit/ag-ui> |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | +## 4. Useful Resources & Docs |
| 37 | + |
| 38 | +| Resource | Link | |
| 39 | +| ----------------------------------------- | -------------------------------------------------------- | |
| 40 | +| Learn how to connect to AG-UI with JS | <https://docs.ag-ui.com/quickstart/connect> | |
| 41 | +| Learn how to connect to AG-UI with Python | <https://docs.ag-ui.com/quickstart/build> | |
| 42 | +| Dojo reference implementation | <https://github.com/ag-ui-protocol/ag-ui/tree/main/dojo> | |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +## 5. Open Your Pull Request |
| 47 | + |
| 48 | +1. **Fork** the repo and create a feature branch. |
| 49 | +2. Keep changes focused—one PR per feature or fix. |
| 50 | +3. Link back to your Discussion in the PR description. |
| 51 | + |
| 52 | +We review PRs weekly. Feel free to nudge us in your Discussion if you haven’t heard back in a few days. |
| 53 | + |
| 54 | +--- |
| 55 | + |
| 56 | +**Thank you for making AG-UI better!** |
0 commit comments