# Contributing to B-MAD Observability Agent

Thank you for your interest in contributing! This document provides guidelines for contributing to this project.

## How to Contribute

### Reporting Issues

- Check existing issues before creating a new one
- Provide clear description and reproduction steps
- Include relevant logs, screenshots, or code snippets
- Tag with appropriate labels (bug, enhancement, documentation, etc.)

### Suggesting Features

- Open an issue with the "enhancement" label
- Describe the use case and benefits
- Provide examples if possible

### Submitting Changes

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Test your changes thoroughly
5. Commit with clear messages (`git commit -m 'Add amazing feature'`)
6. Push to your branch (`git push origin feature/amazing-feature`)
7. Open a Pull Request

### Pull Request Guidelines

- Follow existing code style and conventions
- Update documentation as needed
- Add tests for new functionality
- Ensure all tests pass
- Keep PRs focused on a single feature/fix
- Provide clear PR description

## Code Style

### Agent Configuration (YAML)

- Use 2 spaces for indentation
- Keep prompts clear and concise
- Include examples in prompt content
- Document all menu items

### Workflows

- Use descriptive step names
- Include save_to for all outputs
- Add clear descriptions
- Test workflows before submitting

### Documentation

- Use clear, concise language
- Include code examples
- Add screenshots where helpful
- Keep formatting consistent

## Testing

Before submitting:

1. Test all affected workflows
2. Validate YAML syntax
3. Check for broken links in documentation
4. Verify examples work as documented

## Questions?

Open an issue with the "question" label or reach out on Discord.

Thank you for contributing! 🙏