Skip to content

Building AI agents, atomically

updating documentation for dev guide(lot of the info is dated) and pointing to contribution guide for contributing in the readme.

jon foxb7ca02bca879
diff --git a/README.md b/README.md
index 61d6059..d6c5609 100644
--- a/README.md
+++ b/README.md
@@ -373,7 +373,7 @@ For more information on using and creating tools, see the [Atomic Forge README](
## Contributing
-We welcome contributions! Please see the [Developer Guide](/guides/DEV_GUIDE.md) for detailed information on how to contribute to Atomic Agents. Here are some quick steps:
+We welcome contributions! Please see the [Contributing Guide](/docs/contributing.md) for detailed information on how to contribute to Atomic Agents. Here are some quick steps:
1. Fork the repository
2. Create a new branch (`git checkout -b feature-branch`)
diff --git a/guides/DEV_GUIDE.md b/guides/DEV_GUIDE.md
index 0088eaa..6e684cc 100644
--- a/guides/DEV_GUIDE.md
+++ b/guides/DEV_GUIDE.md
@@ -33,7 +33,11 @@ Atomic Agents uses a monorepo structure, which means multiple related projects a
```
4. Activate the virtual environment:
```
+ # For Poetry < 2.0
poetry shell
+
+ # For Poetry >= 2.0
+ poetry env activate
```
## Development Workflow
@@ -47,17 +51,17 @@ Atomic Agents uses a monorepo structure, which means multiple related projects a
3. Format your code using Black:
```
- black atomic_agents atomic_assembler
+ poetry run black atomic-agents atomic-assembler atomic-examples atomic-forge
```
4. Lint your code using Flake8:
```
- flake8 atomic_agents atomic_assembler
+ poetry run flake8 --extend-exclude=.venv atomic-agents atomic-assembler atomic-examples atomic-forge
```
5. Run the tests:
```
- pytest --cov atomic_agents
+ poetry run pytest --cov=atomic_agents atomic-agents
```
6. If you've added new functionality, make sure to add appropriate tests.