Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC]: Add process for creating a new Task handler to CONTRIBUTING.md #16

Open
2 tasks
drobison00 opened this issue Aug 29, 2024 · 0 comments
Open
2 tasks
Labels
doc Improvements or additions to documentation good first issue Good for newcomers

Comments

@drobison00
Copy link
Collaborator

How would you describe the priority of this documentation request

Would be nice

Describe the future/missing documentation

This will add a new CONTRIBUTING.md section that outlines the steps for adding a new processing task type, and making it available for use via the client library and cli interface.

  • Task Definition:
    • The process for adding a new task to the CLI and library, including --task specification, and configuration options.
  • Processing Module:
    • How to create a new stage/module that checks a control message for a specified task, extracts the task, operates on the message payload, updates the appropriate elements, and forwards the control message to the next stage.
    • How to add the new stage/module to the pipeline
    • Setting up the module for proper unit testing.

Where have you looked?

No response

@drobison00 drobison00 added doc Improvements or additions to documentation good first issue Good for newcomers labels Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant