contributing.md

Contributing Guide

Thank you for your interest in contributing to Atomic Agents! This guide will help you get started with contributing to the project.

Ways to Contribute

There are many ways to contribute to Atomic Agents:

1. Report Bugs: Submit bug reports on our Issue Tracker
2. Suggest Features: Share your ideas for new features or improvements
3. Improve Documentation: Help us make the documentation clearer and more comprehensive
4. Submit Code: Fix bugs, add features, or create new tools
5. Share Examples: Create example projects that showcase different use cases
6. Write Tests: Help improve our test coverage and reliability

Development Setup

1. Fork and clone the repository:

   git clone https://github.com/YOUR_USERNAME/atomic-agents.git
   cd atomic-agents

2. Install dependencies:

   poetry install

3. Set up pre-commit hooks:

   pre-commit install

4. Create a new branch:

   git checkout -b feature/your-feature-name

Code Style

We follow these coding standards:

• Use Black for code formatting
• Follow PEP 8 style guide
• Write docstrings in Google style
• Add type hints to function signatures
• Keep functions focused and modular
• Write clear commit messages

Creating Tools

When creating new tools:

1. Use the tool template:

   atomic-assembler create-tool my-tool

2. Implement the required interfaces:

   from pydantic import BaseModel
   from atomic_agents.lib.tools import BaseTool
   
   class MyToolInputs(BaseModel):
       # Define input schema
       pass
   
   class MyToolOutputs(BaseModel):
       # Define output schema
       pass
   
   class MyTool(BaseTool):
       name = "my_tool"
       description = "Tool description"
       inputs_schema = MyToolInputs
       outputs_schema = MyToolOutputs
   
       def run(self, inputs: MyToolInputs) -> MyToolOutputs:
           # Implement tool logic
           pass

3. Add comprehensive tests:

   def test_my_tool():
       tool = MyTool()
       inputs = MyToolInputs(...)
       result = tool.run(inputs)
       assert isinstance(result, MyToolOutputs)
       # Add more assertions

4. Document your tool:

   • Add a README.md with usage examples
   • Include configuration instructions
   • Document any dependencies
   • Explain error handling

Testing

Run tests with pytest:

poetry run pytest

Include tests for:

• Normal operation
• Edge cases
• Error conditions
• Async functionality
• Integration with other components

Documentation

When adding documentation:

1. Follow the existing structure
2. Include code examples
3. Add type hints and docstrings
4. Update relevant guides
5. Build and verify locally:

   cd docs
   poetry run sphinx-build -b html . _build/html

Submitting Changes

1. Commit your changes:

   git add .
   git commit -m "feat: add new feature"

2. Push to your fork:

   git push origin feature/your-feature-name

3. Create a Pull Request:

   • Describe your changes
   • Reference any related issues
   • Include test results
   • Add documentation updates

Getting Help

If you need help:

• Join our Reddit community
• Check the documentation
• Ask questions on GitHub Discussions

Code of Conduct

Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms. You can find the full text in our GitHub repository.