add-unit-tests

Create unit tests for AReaL using templates and naming conventions.

5.7k|573|Updated Feb 24, 2025
One-click install
npx skills add https://github.com/inclusionAI/AReaL --skill add-unit-tests-inclusionai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-unit-tests
Source: https://github.com/inclusionAI/AReaL/tree/main/.claude/skills/add-unit-tests
Command: npx skills add https://github.com/inclusionAI/AReaL --skill add-unit-tests-inclusionai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams quickly scaffold and enforce consistent unit tests in AReaL, reducing debugging time and regression risk.

Core Features & Use Cases

  • Provides a structured template for test organization, naming conventions, and CI-friendly patterns.
  • Documents best practices for testing strategies across datasets, models, and utilities.
  • Use Case: When adding a new dataset loader or model module, create corresponding tests following the provided templates.

Quick Start

To add unit tests for a new feature, create a test file under areal/tests following test_<module>_<feature>.py and reference the shared utilities from areal/tests/utils.

Frequently Asked Questions about add-unit-tests

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add unit tests for AReaL modules using pytest?

Standardize AReaL unit tests by creating files under areal/tests using the test_<module>_<feature>.py naming convention, referencing shared utilities from areal/tests/utils to implement CI-ready testing patterns.

What is the standard file naming convention for AReaL testing patterns?

The standard naming convention for AReaL testing patterns requires test files to be named test_<module>_<feature>.py and placed under the areal/tests directory to maintain consistent test organization and reduce regression risk.

When should I implement unit tests in the AReaL project?

You should implement unit tests in the AReaL project when adding new functionality, fixing bugs, or extending datasets, ensuring that new dataset loaders or model modules have corresponding tests following the provided templates.

Does the AReaL unit test template support CI-friendly testing strategies?

Yes, the AReaL unit test template provides a structured organization for CI-friendly testing patterns, documenting best practices for testing strategies across datasets, models, and utilities to accelerate robust test implementation.

What testing strategies are recommended for AReaL dataset loaders and model modules?

Recommended testing strategies for AReaL dataset loaders and model modules involve following the structured templates under areal/tests, utilizing shared utilities from areal/tests/utils, and applying CI-ready practices to ensure robust test coverage.