Contributor Guidelines

This repository provides additional nodes for the nodetool project and depends on nodetool-core.

Code Style

Use Python 3.11+ syntax.
All nodes live under
```
src/nodetool/nodes/lib
```
and must inherit from
```
BaseNode
```
.
Node attributes are defined with
```
pydantic.Field
```
and async
```
process
```
methods should return the appropriate reference type.
Each node must contain a short docstring describing the model and several example use cases.
Provide a
```
get_basic_fields
```
class method listing the most relevant fields

After adding or changing nodes run these commands to generate metadata and DSL.

nodetool package scan
nodetool codegen

Before submitting a pull request, run the following checks:

ruff check .
black --check .
pytest -q

Formatting issues or lint errors should be fixed before committing. Test coverage is expected to be added when applicable.

This repository provides additional nodes for the nodetool project and depends on nodetool-core.

Use Python 3.11+ syntax.
All nodes live under
```
src/nodetool/nodes/lib
```
and must inherit from
```
BaseNode
```
.
Node attributes are defined with
```
pydantic.Field
```
and async
```
process
```
methods should return the appropriate reference type.
Each node must contain a short docstring describing the model and several example use cases.
Provide a
```
get_basic_fields
```
class method listing the most relevant fields

After adding or changing nodes run these commands to generate metadata and DSL.

nodetool package scan
nodetool codegen

Before submitting a pull request, run the following checks:

ruff check .
black --check .
pytest -q

Formatting issues or lint errors should be fixed before committing. Test coverage is expected to be added when applicable.