You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Components live under `components/<category>/<component_name>/`.
69
-
- Components can optionally use subcategories: `components/<category>/<subcategory>/<component_name>/`.
70
-
- Pipelines live under `pipelines/<category>/<pipeline_name>/`.
71
-
- Pipelines can optionally use subcategories: `pipelines/<category>/<subcategory>/<pipeline_name>/`.
72
-
- Use `snake_case` directory names (per `CONTRIBUTING.md`).
73
-
74
48
### Required files
75
49
76
50
When the agent changes or adds a component/pipeline directory, follow
@@ -88,57 +62,18 @@ Process (expected for agents):
88
62
- Open a submission issue using `.github/ISSUE_TEMPLATE/component_submission.md`.
89
63
- Get Pipelines Working Group approval in that issue (link it from the PR).
90
64
- Open a PR with the implementation.
91
-
- Follow the repo’s OWNERS-based review flow described in `CONTRIBUTING.md` (`/lgtm` + `/approve`).
92
-
93
-
### Example prompts (Mode 1)
94
-
95
-
#### Add a new component (reuse-first, compliant)
96
-
97
-
Use this prompt pattern:
98
-
99
-
"Search `components/` for similar functionality and reuse if possible. If a new component is needed, create it under
100
-
`components/<category>/<name>/` using `make component CATEGORY=<cat> NAME=<name> [NO_TESTS=true]`, then implement
101
-
`component.py` following repository lint rules (including import guard). Create `metadata.yaml` that conforms to
102
-
the metadata schema defined in [`CONTRIBUTING.md`](docs/CONTRIBUTING.md#metadatayaml-schema) (required field order, fresh `lastVerified`). Generate/validate
103
-
`README.md` using `make readme TYPE=component CATEGORY=<cat> NAME=<name>`. Add unit tests using `.python_func()` and a
104
-
LocalRunner test using `setup_and_teardown_subprocess_runner` (you can generate tests via
105
-
`make tests TYPE=component CATEGORY=<cat> NAME=<name>`). Reference an existing component like
106
-
`components/data_processing/yoda_data_processor/` for patterns."
107
-
108
-
#### Add a component in a subcategory
109
-
110
-
Use this prompt pattern when creating related components that should share ownership or utilities:
111
-
112
-
"Create a component in a subcategory using `make component CATEGORY=<cat> SUBCATEGORY=<sub> NAME=<name>`. This
113
-
automatically creates the subcategory structure with OWNERS and README.md if it doesn't exist. For shared utilities,
114
-
add `CREATE_SHARED=true` to create a `shared/` package. Update the subcategory OWNERS and README.md with appropriate
115
-
maintainers and documentation. Follow the same component implementation patterns as above."
116
-
117
-
#### Add a new pipeline (reuse-first, compliant)
118
-
119
-
Use this prompt pattern:
65
+
- Follow the repo's OWNERS-based review flow described in `CONTRIBUTING.md` (`/lgtm` + `/approve`).
120
66
121
-
"Search `pipelines/` for similar functionality and reuse if possible. If a new pipeline is needed, create it under
122
-
`pipelines/<category>/<name>/` using `make pipeline CATEGORY=<cat> NAME=<name> [NO_TESTS=true]`, then implement
123
-
`pipeline.py` following repository lint rules (including import guard). Create `metadata.yaml` that conforms to the
124
-
metadata schema defined in [`CONTRIBUTING.md`](docs/CONTRIBUTING.md#metadatayaml-schema) (required field order, fresh
| Import guard |[`import_exceptions.yaml`](.github/scripts/check_imports/import_exceptions.yaml); see [`CONTRIBUTING.md`](docs/CONTRIBUTING.md#testing-and-quality)|[`ci-checks.yml`](.github/workflows/ci-checks.yml)|
126
+
| Metadata schema |[`CONTRIBUTING.md` (schema)](docs/CONTRIBUTING.md#metadatayaml-schema); keep required field order and fresh `lastVerified`|[`validate-metadata-schema.yml`](.github/workflows/validate-metadata-schema.yml)|
127
+
| Base images |[`validate_base_images/README.md`](scripts/validate_base_images/README.md)|[`base-image-check.yml`](.github/workflows/base-image-check.yml)|
0 commit comments