feat: create example folder with example plugin #1004
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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?
packages/_examples/plugin/
src/plugins/samplePlugin.ts
- Main plugin definitionsrc/actions/sampleAction.ts
- Example action implementationsrc/providers/sampleProvider.ts
- Example provider implementationsrc/evaluators/sampleEvaluator.ts
- Example evaluator implementationDetailed testing steps