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
38 changes: 35 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ First of all, __thank you__ for your interest in contributing to AgentStack! Eve

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

### Exclusive Contributor Sticker
AgentStack contributors all receive a free sticker pack including an exclusive holographic sticker only available to contributors to the project :)

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

## How to Help

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!
Expand All @@ -18,8 +23,6 @@ The best place to engage in conversation about your contribution is in the Issue
`pip install -e .[dev,test]`
This will install the CLI locally and in editable mode so you can use `agentstack <command>` to test your latest changes

## Project Structure
TODO

## Adding Tools
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!
Expand Down Expand Up @@ -61,4 +64,33 @@ pre-commit install
```

## Tests
HAHAHAHAHAHAHA good one
CLI tests are a bit hacky, so we are not tracking coverage.
That said, _some_ testing is required for any new functionality added by a PR.

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.

### Run tests locally
Install the testing requirements
```bash
pip install 'agentstack[test]'
```

Then run tests in all supported python versions with
```bash
tox
```

## Need Help?
If you're reading this, we're very thankful you wanted to contribute! I understand it can be a little overwhelming to
get up to speed on a project like this and we are here to help!

### Open a draft PR
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 :)

### Chat on our Discord
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!

# Thank You!
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.

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!
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# {{ cookiecutter.project_metadata.project_name }}
{{ cookiecutter.project_metadata.description }}

~~ Built with AgentStack ~~

## How to build your Crew
### With the CLI
Add an agent using AgentStack with the CLI:
Expand All @@ -21,7 +19,7 @@ Add tools with `agentstack tools add` and view tools available with `agentstack
In this directory, run `poetry install`

To run your project, use the following command:
`crewai run` or `python src/main.py`
`agentstack run`

This will initialize your crew of AI agents and begin task execution as defined in your configuration in the main.py file.

Expand All @@ -36,3 +34,4 @@ If you need to reset the memory of your crew before running it again, you can do
`crewai reset-memory`
This will clear the crew's memory, allowing for a fresh start.

> 🪩 Project built with [AgentStack](https://github.com/AgentOps-AI/AgentStack)
Empty file removed foo.yaml
Empty file.
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ build-backend = "setuptools.build_meta"

[project]
name = "agentstack"
version = "0.2.2.2"
version = "0.2.3"
description = "The fastest way to build robust AI agents"
authors = [
{ name="Braelyn Boynton", email="bboynton97@gmail.com" }
{ name="Braelyn Boynton", email="bboynton97@gmail.com" },
{ name="Travis Dent", email=" root@a10k.co" }
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

]
license = { text = "MIT" }
readme = "README.md"
Expand Down
Loading