Skip to content

Commit 22d539c

Browse files
Update CONTRIBUTING.md (#188)
1 parent 896c46d commit 22d539c

File tree

1 file changed

+45
-31
lines changed

1 file changed

+45
-31
lines changed

CONTRIBUTING.md

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,71 @@
1-
# Contributing to AG-UI
1+
# 👋 Contributing to AG-UI
22

3-
Thanks for your interest in improving **AG-UI**!
3+
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.
44

5-
This short guide shows the fastest way to get your idea merged.
6-
You can find more detailed contribution guides at [ag-ui.com](ag-ui.com)
5+
Here’s how to get involved:
76

87
---
98

10-
## 1. Start a Discussion
9+
## 🤔 Have a Question or Ran Into Something?
1110

12-
Before writing code, open a new **Discussion** and briefly cover:
11+
Pick the right spot so we can help you faster:
1312

14-
1. **Problem** – what you’re trying to solve.
15-
2. **Proposal** – how you plan to solve it (code, docs, design, etc.).
16-
3. **Alternatives** – other options you considered.
17-
18-
Early feedback keeps everyone aligned and saves re-work.
13+
- **🐛 Bugs / Feature Ideas**[GitHub Issues](https://github.com/ag-ui-protocol/ag-ui/issues)
14+
- **❓ "How do I...?" / General Questions**[GitHub Discussions](https://github.com/ag-ui-protocol/ag-ui/discussions)
15+
- **💬 Quick chats / casual stuff**[Discord](https://discord.gg/Jd3FzfdJa8)`#-💎-contributing`
1916

2017
---
2118

22-
## 2. Join a Bi-Weekly Working Group
19+
## 🧑‍💻 Want to Contribute Code?
2320

24-
Meet the team and potential collaborators in our [bi-weekly community call](https://lu.ma/calendar/manage/cal-DBw2gK428IQbiSO).
21+
1. **Find Something to Work On**
22+
Browse open issues on [GitHub](https://github.com/ag-ui-protocol/ag-ui/issues).
23+
Got your own idea? Open an issue first so we can start the discussion.
2524

26-
---
25+
2. **Ask to Be Assigned**
26+
Comment on the issue and tag a code owner:
27+
[Code Owners](https://github.com/ag-ui-protocol/ag-ui/blob/main/.github/CODEOWNERS)
28+
29+
3. **Get on the Roadmap**
30+
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).
2731

28-
## 3. Connect with the Maintainers
32+
4. **Coordinate With Others**
33+
- If you're collaborating or need feedback, start a thread in `#-💎-contributing` on Discord
34+
- Or just DM the assignee directly
2935

30-
Need a quick sync?
36+
5. **Open a Pull Request**
37+
- When you’re ready, submit your PR
38+
- In the description, include: `Fixes #<issue-number>`
39+
(This links your PR to the issue and closes it automatically)
3140

32-
- **Markus:** [@mme_xyz](https://twitter.com/mme_xyz) on X (Twitter)
33-
- **Book a chat:** <https://calendly.com/markus-copilotkit/ag-ui>
41+
6. **Review & Merge**
42+
- A maintainer will review your code and leave comments if needed
43+
- Once it’s approved, we’ll merge it and move the issue to “done.”
3444

3545
---
3646

37-
## 4. Useful Resources & Docs
47+
## 📝 Want to Contribute to the Docs?
3848

39-
| Resource | Link |
40-
| ----------------------------------------- | -------------------------------------------------------- |
41-
| Learn how to connect to AG-UI with JS | <https://docs.ag-ui.com/quickstart/connect> |
42-
| Learn how to connect to AG-UI with Python | <https://docs.ag-ui.com/quickstart/build> |
43-
| Dojo reference implementation | <https://github.com/ag-ui-protocol/ag-ui/tree/main/dojo> |
49+
Docs are part of the codebase and super valuable—thanks for helping improve them!
4450

45-
---
51+
Here’s how to contribute:
52+
53+
1. **Open an Issue First**
54+
- Open a [GitHub issue](https://github.com/ag-ui-protocol/ag-ui/issues) describing what you’d like to update or add.
55+
- Then comment and ask to be assigned.
4656

47-
## 5. Open Your Pull Request
57+
2. **Submit a PR**
58+
- Once assigned, make your edits and open a pull request.
59+
- In the description, include: `Fixes #<issue-number>`
60+
(This links your PR to the issue and closes it automatically)
4861

49-
1. **Fork** the repo and create a feature branch.
50-
2. Keep changes focused—one PR per feature or fix.
51-
3. Link back to your Discussion in the PR description.
62+
- A maintainer will review it and merge if it looks good.
5263

53-
We review PRs weekly. Feel free to nudge us in your Discussion if you haven’t heard back in a few days.
64+
That’s it! Simple and appreciated.
5465

5566
---
5667

57-
**Thank you for making AG-UI better!**
68+
## 🙌 That’s It!
69+
70+
AG-UI is community-built, and every contribution helps shape where we go next.
71+
Big thanks for being part of it!

0 commit comments

Comments
 (0)