Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

<!--
**Please PLEASE reach out to us first before starting any significant work on new or existing features.**
By the time you've gotten here, you're looking at creating a pull request so hopefully we're not too late.
We love community contributions! That said, we want to make sure we're all on the same page before you start.
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.
It also helps to make sure the work you're planning isn't already in progress.
As described in our contributing guide, please file an issue first: https://github.com/ag-ui-protocol/ag-ui/issues
Or, reach out to us on Discord: https://discord.gg/Jd3FzfdJa8
Take a look at the contributing guide:
https://github.com/ag-ui-protocol/ag-ui/blob/main/CONTRIBUTING.md
-->
48 changes: 29 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,36 +10,46 @@ Here’s how to get involved:

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)
- **🐛 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`

---

## 🧑‍💻 Want to Contribute Code?

1. **Find Something to Work On**
Browse open issues on [GitHub](https://github.com/ag-ui-protocol/ag-ui/issues).
First, an important plea:
**Please PLEASE reach out to us first before starting any significant work on new or existing features.**

We love community contributions! That said, we want to make sure we're all on the same page before you start.
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.
It also helps to make sure the work you're planning isn't already in progress.

As described below, please file an issue first: https://github.com/ag-ui-protocol/ag-ui/issues
Or, reach out to us on Discord: https://discord.gg/Jd3FzfdJa8

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:
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**
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
4. **Coordinate With Others**
- If you're collaborating or need feedback, start a thread in `#-💎-contributing` on Discord
- Or just DM the assignee directly

5. **Open a Pull Request**
- When you’re ready, submit your PR
- In the description, include: `Fixes #<issue-number>`
5. **Open a Pull Request**
- When you’re ready, submit your PR
- In the description, include: `Fixes #<issue-number>`
(This links your PR to the issue and closes it automatically)

6. **Review & Merge**
- A maintainer will review your code and leave comments if needed
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.”

**NOTE:** All community integrations (ie, .NET, Golang SDK, etc.) will need to be maintained by the community
Expand All @@ -52,13 +62,13 @@ Docs are part of the codebase and super valuable—thanks for helping improve th

Here’s how to contribute:

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.
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.

2. **Submit a PR**
2. **Submit a PR**
- Once assigned, make your edits and open a pull request.
- In the description, include: `Fixes #<issue-number>`
- In the description, include: `Fixes #<issue-number>`
(This links your PR to the issue and closes it automatically)

- A maintainer will review it and merge if it looks good.
Expand All @@ -69,5 +79,5 @@ That’s it! Simple and appreciated.

## 🙌 That’s It!

AG-UI is community-built, and every contribution helps shape where we go next.
AG-UI is community-built, and every contribution helps shape where we go next.
Big thanks for being part of it!
Loading