Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (40 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

51 lines (40 loc) · 1.66 KB
Raw

Contributing to AACR-Bench

Thank you for your interest in AACR-Bench! We welcome contributions of all kinds, including but not limited to:

  • 🐛 Reporting issues and suggestions
  • 📝 Improving documentation
  • 🔧 Submitting code fixes
  • ✨ Adding new features
  • 🌐 Contributing new evaluation data
  • 🧪 Improving test coverage

Code Contribution Guidelines

Reporting Issues

  1. Search existing issues to check if the problem has already been reported
  2. Create a new issue using the appropriate issue template
  3. Provide as much detail as possible:
    • Environment information (OS, Python version, etc.)
    • Steps to reproduce
    • Expected behavior vs actual behavior
    • Relevant logs or screenshots

Proposing New Features

  1. Start by discussing your idea in Discussions
  2. After receiving community feedback, create a feature request issue
  3. If you're willing to implement the feature, please indicate so and wait for maintainer confirmation

Data Contribution Guidelines

If you'd like to contribute new PR data, please ensure:

  1. Data Quality
    • PRs are from active open-source projects
    • Contains meaningful code changes
    • Has high-quality human reviews
  2. Data Format
    • Conforms to the specified JSON schema
    • Includes complete metadata
    • Has been properly anonymized
  3. Annotation Requirements
    • Reviewed by at least 2 experts
    • Covers various issue types

Submitting Data

  1. Place data in the data/contributions/ directory
  2. Create a PR and explain the data source

Acknowledgments

Thank you to all contributors for their dedication! Your contributions make AACR-Bench better.

Happy Contributing! 🎉