Skip to content

Commit a7d53ff

Browse files
committed
Update ADDING_PROJECTS.md and README.md for clarity and guidance
This commit adds a note in ADDING_PROJECTS.md indicating that the guide is primarily for internal development use. It also standardizes the tag formatting to lowercase for consistency. Additionally, a reference to CLAUDE.md is included in README.md to provide development guidance for contributors.
1 parent d2a8ecf commit a7d53ff

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

ADDING_PROJECTS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Adding Projects to ZenML Projects Repository
22

3+
<!-- Note: This guide is primarily for ZenML internal development use -->
4+
35
This guide explains how to add your ZenML project to this repository and make it available through the ZenML Projects platform.
46

57
## 📋 Requirements
@@ -101,9 +103,9 @@ stack:
101103
# Add other stack components if needed
102104

103105
tags:
104-
- Domain (e.g., LLMOps, Computer Vision, MLOps)
105-
- Technology (e.g., PyTorch, TensorFlow, Hugging Face)
106-
- Use Case (e.g., Classification, Forecasting, NLP)
106+
- domain (e.g., llmops, cv, mlops)
107+
- technology (e.g., pytorch, tensorflow, hugging-face)
108+
- use-case (e.g., classification, forecasting, nlp)
107109

108110
tools_used:
109111
- zenml

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,8 @@ installation details.
8686
We welcome contributions from anyone to showcase your project built using ZenML.
8787
See our [contributing guide](./CONTRIBUTING.md) to start.
8888

89+
For information on working with this codebase, see [CLAUDE.md](./CLAUDE.md) for development guidance.
90+
8991
## Code Quality
9092

9193
All code contributions must pass our automated code quality checks:

0 commit comments

Comments
 (0)