NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: Add process for creating a new Task handler to CONTRIBUTING.md
Open
Nobody has claimed this yet.
doc
good first issue
- Dominant language
- Python
- Stars
- 3k
- Forks
- 349
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
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
--taskspecification, and configuration options.
- The process for adding a new task to the CLI and library, including
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with CONTRIBUTING.md and trace how task types are exposed through the client library and CLI, including the --task specification and configuration options. Then review the processing stage/module pipeline and its unit tests. Done means a clear section covers task definition, module behavior, pipeline registration, and testing steps.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100