eliza icon indicating copy to clipboard operation
eliza copied to clipboard

feat: create example folder with example plugin

Open monilpat opened this issue 1 year ago • 0 comments

Relates to:

Initial setup of example plugin structure, to come examples of adapters, clients, services, etc. This will make it easier to standardize development, best practices, code review, and ultimately quality of the repo.

Risks

Low - This is an example plugin that serves as a template/reference implementation

Background

What does this PR do?

Creates an example plugin folder with a sample implementation including:

  • Basic plugin structure
  • Sample actions, providers, and evaluators
  • TypeScript configuration
  • Build setup with tsup
  • NPM package configuration

What kind of change is this?

Features (non-breaking change which adds functionality)

Documentation changes needed?

My changes do require a change to the project documentation which is included. Will update the global readme once all examples are added.

Testing

Where should a reviewer start?

  1. Review the plugin structure in packages/_examples/plugin/
  2. Key files to review:
    • src/plugins/samplePlugin.ts - Main plugin definition
    • src/actions/sampleAction.ts - Example action implementation
    • src/providers/sampleProvider.ts - Example provider implementation
    • src/evaluators/sampleEvaluator.ts - Example evaluator implementation

Detailed testing steps

  1. Navigate to the plugin directory:

monilpat avatar Dec 12 '24 04:12 monilpat