Content Evaluation Tool

A tool designed to evaluate and analyze content for CRGA

Installation

To install the CLI globally on your system, run the following command in the terminal:

npm install -g content-eval-tool

Getting Started

1. Create a new folder for your evaluation project:

2. Run the tool by executing following command in the terminal

cet

3. Configure your environment (organization, pipelines, sources):

cet configure

4. Evaluate your content:

cet evaluate

Commands

cet <command> [options]

| Command | Description | |-------------|----------------------------------------------| | configure | Set up organization, pipelines, and sources | | evaluate | Run content quality evaluation | | report | Generate a report of the evaluation test | | help | Show help and examples |

Examples

cet configure => Start interactive configuration
cet configure -s => Show current config
cet evaluate => Evaluate current content setup
cet report => Generate a report of the evaluation test

Development Conventions

This project uses conventional commits and branch naming:

Prefixes

• test: Adding tests or correcting existing tests
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• chore: Changes which don't change source code or tests
• refactor: A code change that neither fixes a bug nor adds a feature
• style: Changes that do not affect the meaning of the code
• build: Changes that affect the build system or external dependencies
• ci: Changes to CI configuration files and scripts
• docs: Documentation only changes
• revert: Revert something

Naming Style

• Use camelCase for all naming conventions (variables, functions, tests, etc.)

Branch naming:

• test/wordCount
• feat/progressBar
• fix/documentBodyFetchError

Commit messages:

• test: add unit tests for search API
• feat: implement search results filtering
• docs: add usage examples for search API