@@ -10,36 +10,46 @@ Here’s how to get involved:
1010
1111Pick the right spot so we can help you faster:
1212
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 )
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 )
1515- ** 💬 Quick chats / casual stuff** → [ Discord] ( https://discord.gg/Jd3FzfdJa8 ) → ` #-💎-contributing `
1616
1717---
1818
1919## 🧑💻 Want to Contribute Code?
2020
21- 1 . ** Find Something to Work On**
22- Browse open issues on [ GitHub] ( https://github.com/ag-ui-protocol/ag-ui/issues ) .
21+ First, an important plea:
22+ ** Please PLEASE reach out to us first before starting any significant work on new or existing features.**
23+
24+ We love community contributions! That said, we want to make sure we're all on the same page before you start.
25+ Investing a lot of time and effort just to find out it doesn't align with the upstream project feels awful, and we don't want that to happen.
26+ It also helps to make sure the work you're planning isn't already in progress.
27+
28+ As described below, please file an issue first: https://github.com/ag-ui-protocol/ag-ui/issues
29+ Or, reach out to us on Discord: https://discord.gg/Jd3FzfdJa8
30+
31+ 1 . ** Find Something to Work On**
32+ Browse open issues on [ GitHub] ( https://github.com/ag-ui-protocol/ag-ui/issues ) .
2333 Got your own idea? Open an issue first so we can start the discussion.
2434
25- 2 . ** Ask to Be Assigned**
26- Comment on the issue and tag a code owner:
35+ 2 . ** Ask to Be Assigned**
36+ Comment on the issue and tag a code owner:
2737 → [ Code Owners] ( https://github.com/ag-ui-protocol/ag-ui/blob/main/.github/CODEOWNERS )
2838
29- 3 . ** Get on the Roadmap**
39+ 3 . ** Get on the Roadmap**
3040 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 ) .
3141
32- 4 . ** Coordinate With Others**
33- - If you're collaborating or need feedback, start a thread in ` #-💎-contributing ` on Discord
42+ 4 . ** Coordinate With Others**
43+ - If you're collaborating or need feedback, start a thread in ` #-💎-contributing ` on Discord
3444 - Or just DM the assignee directly
3545
36- 5 . ** Open a Pull Request**
37- - When you’re ready, submit your PR
38- - In the description, include: ` Fixes #<issue-number> `
46+ 5 . ** Open a Pull Request**
47+ - When you’re ready, submit your PR
48+ - In the description, include: ` Fixes #<issue-number> `
3949 (This links your PR to the issue and closes it automatically)
4050
41- 6 . ** Review & Merge**
42- - A maintainer will review your code and leave comments if needed
51+ 6 . ** Review & Merge**
52+ - A maintainer will review your code and leave comments if needed
4353 - Once it’s approved, we’ll merge it and move the issue to “done.”
4454
4555** NOTE:** All community integrations (ie, .NET, Golang SDK, etc.) will need to be maintained by the community
@@ -52,13 +62,13 @@ Docs are part of the codebase and super valuable—thanks for helping improve th
5262
5363Here’s how to contribute:
5464
55- 1 . ** Open an Issue First**
56- - Open a [ GitHub issue] ( https://github.com/ag-ui-protocol/ag-ui/issues ) describing what you’d like to update or add.
65+ 1 . ** Open an Issue First**
66+ - Open a [ GitHub issue] ( https://github.com/ag-ui-protocol/ag-ui/issues ) describing what you’d like to update or add.
5767 - Then comment and ask to be assigned.
5868
59- 2 . ** Submit a PR**
69+ 2 . ** Submit a PR**
6070 - Once assigned, make your edits and open a pull request.
61- - In the description, include: ` Fixes #<issue-number> `
71+ - In the description, include: ` Fixes #<issue-number> `
6272 (This links your PR to the issue and closes it automatically)
6373
6474 - A maintainer will review it and merge if it looks good.
@@ -69,5 +79,5 @@ That’s it! Simple and appreciated.
6979
7080## 🙌 That’s It!
7181
72- AG-UI is community-built, and every contribution helps shape where we go next.
82+ AG-UI is community-built, and every contribution helps shape where we go next.
7383Big thanks for being part of it!
0 commit comments