Contributing

Thank you for your interest in contributing to AI AutoEvals!

Documentation Generated with AI Assistance

This documentation website was generated with significant assistance from an AI assistant. While the technical content is accurate and based on the actual AI AutoEvals module code, the structure, formatting, and some explanations were created through AI-human collaboration.

If you find any inaccuracies, unclear sections, or areas for improvement in this documentation, please report them or submit a PR to help improve it for everyone.

Maintainer

This module is maintained by Dimitris Spachos.

Development Setup

1. Clone the repository
2. Install dependencies with Composer
3. Set up a local Drupal development environment
4. Enable the module and its dependencies

Coding Standards

This project follows Drupal coding standards. Please ensure your code:

• Follows Drupal Coding Standards
• Includes proper PHPDoc comments
• Uses strict types (declare(strict_types=1))
• Has no PHPCS errors

Run coding standards checks:

./vendor/bin/phpcs --standard=Drupal modules/custom/ai_autoevals
./vendor/bin/phpcs --standard=DrupalPractice modules/custom/ai_autoevals

Running Tests

Run tests to ensure your changes work correctly:

# Run all tests
./vendor/bin/phpunit -c core/modules/simpletest/phpunit.xml modules/custom/ai_autoevals/tests

# Run specific test suite
./vendor/bin/phpunit -c core/modules/simpletest/phpunit.xml modules/custom/ai_autoevals/tests/src/Unit
./vendor/bin/phpunit -c core/modules/simpletest/phpunit.xml modules/custom/ai_autoevals/tests/src/Kernel

Pull Request Process

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add/update tests as needed
5. Ensure all tests pass
6. Submit a pull request

PR Guidelines

• Keep PRs focused on a single feature or fix
• Write descriptive commit messages
• Update documentation as needed
• Reference any related issues

Reporting Issues

When reporting issues, please include:

• Drupal version
• AI module version
• PHP version
• Steps to reproduce
• Expected vs actual behavior
• Any error messages

Feature Requests

Feature requests are welcome! Please:

• Check existing issues first
• Describe the use case clearly
• Explain how the feature would work

Questions

For questions, use the Drupal.org issue queue or contact the maintainers.

License

By contributing, you agree that your contributions will be licensed under the GPL-2.0-or-later license.