Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
146 lines (102 loc) 路 4.83 KB

CONTRIBUTING.md

File metadata and controls

146 lines (102 loc) 路 4.83 KB
Raw

Contributing to Awesome AI Agent Testing

Thank you for your interest in contributing to the Awesome AI Agent Testing list! This resource aims to be the most comprehensive collection of AI agent testing tools, frameworks, and methodologies. Your contributions help the community stay up-to-date with the rapidly evolving field.

How to Contribute

Before You Start

  1. Check Existing Content: Search the current list to ensure your suggestion isn't already included
  2. Review Issues: Check open issues to see if someone else has already suggested your addition
  3. Read Guidelines: Familiarize yourself with our quality standards below

Types of Contributions

We welcome the following types of contributions:

  • New Resources: Tools, frameworks, papers, datasets, or services
  • Updates: Corrections to existing entries, updated links, or additional information
  • New Categories: Suggestions for new sections or reorganization
  • Improvements: Better descriptions, formatting, or structure
  • Translations: Help make this resource accessible in other languages

Quality Standards

All contributions should meet these criteria:

  1. Relevance: Directly related to AI agent testing
  2. Quality: Well-maintained, documented, and actively used
  3. Accessibility: Publicly available (open source preferred, commercial accepted)
  4. Description: Clear, concise explanation of what the resource offers
  5. Working Links: All links must be active and point to the correct resource

Submission Process

For Simple Additions

  1. Fork the repository
  2. Create a new branch: git checkout -b add-resource-name
  3. Add your resource in the appropriate section
  4. Follow the formatting guidelines (see below)
  5. Commit your changes: git commit -am 'Add [Resource Name]'
  6. Push to your fork: git push origin add-resource-name
  7. Submit a pull request

For Major Changes

  1. Open an issue first to discuss your proposed changes
  2. Wait for community feedback and approval
  3. Follow the simple addition process above

Formatting Guidelines

For Tools and Frameworks

- [Tool Name](https://link-to-tool) - **[Stars if applicable]** - Brief description (one line).
  - Key feature 1
  - Key feature 2
  - Key feature 3
  - Integration capabilities

For Papers

- [Paper Title](https://link-to-paper) - Brief description highlighting key contributions and relevance to agent testing.

For Resources and Guides

- [Resource Title](https://link-to-resource) - Description explaining what the resource covers and who it's for.

Pull Request Guidelines

Your pull request should:

  1. Have a clear title: "Add [Resource Name] to [Section Name]"
  2. Include a description: Explain why this resource is valuable
  3. Follow formatting: Match the existing style and structure
  4. Pass checks: Ensure no broken links or formatting issues
  5. Be focused: One logical change per pull request

Example Pull Request Description

## Description
Adding CrewAI-Testing-Suite to the Testing Frameworks section.

## Why This Is Valuable
- Provides specialized testing capabilities for role-based AI agents
- Actively maintained with 500+ stars on GitHub
- Fills a gap in multi-agent role testing

## Checklist
- [ ] I've read the contributing guidelines
- [ ] The resource is not already in the list
- [ ] All links are working
- [ ] The description is clear and concise
- [ ] Formatting matches the style guide

Code of Conduct

Our Standards

  • Be Respectful: Treat all contributors with respect
  • Be Constructive: Provide helpful feedback and suggestions
  • Be Inclusive: Welcome contributors of all backgrounds and experience levels
  • Be Professional: Maintain a professional tone in all interactions

Unacceptable Behavior

  • Harassment, discrimination, or offensive language
  • Spam or self-promotion without value
  • Malicious or deceptive content
  • Violation of intellectual property rights

Review Process

  1. Initial Review: Maintainers check for quality and relevance (1-3 days)
  2. Community Feedback: Other contributors may provide input
  3. Revision Period: Address any requested changes
  4. Final Decision: Maintainers merge or close with explanation

Questions?

If you have questions about contributing:

  1. Check existing issues for similar questions
  2. Open a new issue with the "question" label
  3. Join our community discussions

Recognition

We value all contributions! Contributors will be:

  • Listed in our Contributors section
  • Mentioned in release notes for significant additions
  • Eligible for special contributor badges (coming soon)

Thank you for helping make AI agent testing more accessible to everyone!

This contributing guide is adapted from standard open source practices and tailored for the Awesome AI Agent Testing list.