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
+30-3Lines changed: 30 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -18,8 +18,6 @@ The best place to engage in conversation about your contribution is in the Issue
18
18
`pip install -e .[dev,test]`
19
19
This will install the CLI locally and in editable mode so you can use `agentstack <command>` to test your latest changes
20
20
21
-
## Project Structure
22
-
TODO
23
21
24
22
## Adding Tools
25
23
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 +59,33 @@ pre-commit install
61
59
```
62
60
63
61
## Tests
64
-
HAHAHAHAHAHAHA good one
62
+
CLI tests are a bit hacky, so we are not tracking coverage.
63
+
That said, _some_ testing is required for any new functionality added by a PR.
64
+
65
+
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.
66
+
67
+
### Run tests locally
68
+
Install the testing requirements
69
+
```bash
70
+
pip install 'agentstack[test]'
71
+
```
72
+
73
+
Then run tests in all supported python versions with
74
+
```bash
75
+
tox
76
+
```
77
+
78
+
## Need Help?
79
+
If you're reading this, we're very thankful you wanted to contribute! I understand it can be a little overwhelming to
80
+
get up to speed on a project like this and we are here to help!
81
+
82
+
### Open a draft PR
83
+
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 :)
84
+
85
+
### Chat on our Discord
86
+
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!
87
+
88
+
# Thank You!
89
+
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.
90
+
91
+
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