Creating Custom Requirements

Requirement Pattern Types

Evalo supports several types of requirement patterns that allow you to evaluate different aspects of a repository. Each pattern type serves a specific purpose and has its own syntax and capabilities.

• File Existence: Check if specific files or directories exist in the repository (e.g., README.md, package.json, .gitignore).
• Content Pattern: Search for specific content, patterns, or code structures within files using regex or string matching.
• Code Quality: Evaluate code quality metrics like proper naming conventions, documentation, or architectural patterns.
• Structure Check: Verify project structure, folder organization, or adherence to architectural patterns.
• Dependency Check: Validate dependencies, versions, or the presence of specific libraries and frameworks.

Requirement Components

Each custom requirement consists of several key components that define how it will be evaluated:

• Title: A clear, descriptive name for the requirement (e.g., "README file exists").
• Type: The pattern type that determines how the requirement will be checked.
• Level: Priority level - Must (required), Should (quality), or Nice (bonus).
• Pattern: The specific pattern, path, or criteria that will be evaluated.
• Failure Message: A helpful message explaining what's missing when the requirement fails.
• Fix Hint: Actionable guidance on how to meet the requirement.

Creating Your First Custom Requirement

Follow these steps to create a custom requirement for your assessment:

1. 1
   Navigate to Assessment Requirements: Go to your assessment and click on the Requirements tab.
2. 2
   Click "Add Custom Requirement": This opens the custom requirement creation form.
3. 3
   Define the Requirement: Fill in the title, select the type, set the priority level, and define your pattern.
4. 4
   Add Helpful Messages: Write clear failure messages and fix hints to help candidates understand what's expected.
5. 5
   Test and Save: Review your requirement and save it to add it to your assessment.

Example Custom Requirements

Here are some practical examples of custom requirements you might create:

Best Practices

• Be Specific: Write clear, unambiguous requirements that leave no room for interpretation.
• Provide Context: Include helpful failure messages and fix hints to guide candidates.
• Balance Priority: Use "Must" sparingly for essential requirements, "Should" for quality indicators, and "Nice" for bonuses.
• Test Your Patterns: Validate your regex patterns and file paths before adding them to live assessments.
• Focus on Intent: Design requirements that test understanding and implementation skills, not trivial formatting.

Next Steps

Now that you understand custom requirements, here are some recommended next steps:

• Learn about assessment templates for structured requirement creation
• Explore AI-generated requirements to complement your custom ones
• Review the quick start guide for the complete evaluation workflow

---