You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+35-3Lines changed: 35 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,11 @@ First of all, __thank you__ for your interest in contributing to AgentStack! Eve
3
3
4
4
Our vision is to build the defacto CLI for quickly spinning up an AI Agent project. We want to be the [create-react-app](https://create-react-app.dev/) of agents. Our inspiration also includes the oh-so-convenient [Angular CLI](https://v17.angular.io/cli).
5
5
6
+
### Exclusive Contributor Sticker
7
+
AgentStack contributors all receive a free sticker pack including an exclusive holographic sticker only available to contributors to the project :)
8
+
9
+
Once your PR is merge, fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLSfvBEnsT8nsQleonJHoWQtHuhbsgUJ0a9IjOqeZbMGkga2NtA/viewform?usp=sf_link) and I'll send your sticker pack out ASAP! <3
10
+
6
11
## How to Help
7
12
8
13
Grab an issue from the [issues tab](https://github.com/AgentOps-AI/AgentStack/issues)! Plenty are labelled "Good First Issue". Fork the repo and create a PR when ready!
@@ -18,8 +23,6 @@ The best place to engage in conversation about your contribution is in the Issue
18
23
`pip install -e .[dev,test]`
19
24
This will install the CLI locally and in editable mode so you can use `agentstack <command>` to test your latest changes
20
25
21
-
## Project Structure
22
-
TODO
23
26
24
27
## Adding Tools
25
28
If you're reading this section, you probably have a product that AI agents can use as a tool. We're glad you're here!
@@ -61,4 +64,33 @@ pre-commit install
61
64
```
62
65
63
66
## Tests
64
-
HAHAHAHAHAHAHA good one
67
+
CLI tests are a bit hacky, so we are not tracking coverage.
68
+
That said, _some_ testing is required for any new functionality added by a PR.
69
+
70
+
Tests MUST pass to have your PR merged. We _will not_ allow main to be in a failing state, so if your tests are failing, this is your problem to fix.
71
+
72
+
### Run tests locally
73
+
Install the testing requirements
74
+
```bash
75
+
pip install 'agentstack[test]'
76
+
```
77
+
78
+
Then run tests in all supported python versions with
79
+
```bash
80
+
tox
81
+
```
82
+
83
+
## Need Help?
84
+
If you're reading this, we're very thankful you wanted to contribute! I understand it can be a little overwhelming to
85
+
get up to speed on a project like this and we are here to help!
86
+
87
+
### Open a draft PR
88
+
While we can't promise to write code for you, if you're stuck or need advice/help, open a draft PR and explain what you were trying to build and where you're stuck! Chances are, one of us have the context needed to help you get unstuck :)
89
+
90
+
### Chat on our Discord
91
+
We have an active [Discord server](https://discord.gg/JdWkh9tgTQ) with contributors and AgentStack users! There is a channel just for contributors on there. Feel free to drop a message explaining what you're trying to build and why you're stuck. Someone from our team should reply soon!
92
+
93
+
# Thank You!
94
+
The team behind AgentStack believe that the barrier to entry for building agents is far too high right now! We believe that this technology can be streamlined and made more accessible. If you're here, you likely feel the same! Any contribution is appreciated.
95
+
96
+
If you're looking for work, we are _always_ open to hiring passionate engineers of all skill levels! While closing issues cannot guarantee an offer, we've found that engineers who contribute to our open source repo are some of the best we could ever hope to find via recruiters! Be active in the community and let us know you're interested in joining the team!
0 commit comments