Skip to content

Commit 599b94b

Browse files
committed
feat(docs): Add placeholder BESTPRACTICES.md and AGENTS.md
Signed-off-by: Giulio Frasca <gfrasca@redhat.com>
1 parent 870da36 commit 599b94b

File tree

5 files changed

+47
-0
lines changed

5 files changed

+47
-0
lines changed

docs/AGENTS.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# AI Agent Context Guide
2+
3+
*This guide provides context and information for AI agents working with the Kubeflow Pipelines Components Repository.*
4+
5+
## Coming Soon
6+
7+
This document serves as a comprehensive context source for AI agents to understand:
8+
- Repository structure and organization
9+
- Component development patterns and standards
10+
- Contribution workflows and processes
11+
- Code quality requirements and testing practices
12+
- Community guidelines and governance
13+
14+
---
15+
16+
For immediate guidance, see:
17+
- [Contributing Guide](CONTRIBUTING.md)
18+
- [Onboarding Guide](ONBOARDING.md)
19+
- [Best Practices Guide](BESTPRACTICES.md)

docs/BESTPRACTICES.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Component Development Best Practices
2+
3+
*This guide is under development. Please check back soon for comprehensive best practices for developing Kubeflow Pipelines components.*
4+
5+
## Coming Soon
6+
7+
This document will cover:
8+
- Component design patterns
9+
- Performance optimization
10+
- Security best practices
11+
- Error handling strategies
12+
- Documentation standards
13+
- Testing methodologies
14+
- Container optimization
15+
- Resource management
16+
17+
---
18+
19+
For immediate guidance, see:
20+
- [Contributing Guide](CONTRIBUTING.md)
21+
- [Onboarding Guide](ONBOARDING.md)
22+
- [Testing Guide](TESTING.md)

docs/CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,8 @@ All PRs must pass:
282282
- **Setup**: [ONBOARDING.md](ONBOARDING.md)
283283
- **Testing**: [TESTING.md](TESTING.md)
284284
- **Governance**: [GOVERNANCE.md](GOVERNANCE.md)
285+
- **Best Practices**: [BESTPRACTICES.md](BESTPRACTICES.md) *(coming soon)*
286+
- **Agents**: [AGENTS.md](AGENTS.md) *(coming soon)*
285287
- **Community**: [#kubeflow-pipelines Slack](https://kubeflow.slack.com/channels/kubeflow-pipelines)
286288
- **Issues**: [GitHub Issues](https://github.com/kubeflow/pipeline-components/issues) for bugs/features
287289

docs/GOVERNANCE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,8 @@ This governance model ensures quality, sustainability, and community collaborati
198198
- **[Contributing Guide](CONTRIBUTING.md)** - How to contribute components
199199
- **[Onboarding Guide](ONBOARDING.md)** - Getting started as a contributor
200200
- **[Testing Guide](TESTING.md)** - Code quality and testing standards
201+
- **[Best Practices Guide](BESTPRACTICES.md)** - Component development best practices *(coming soon)*
202+
- **[Agents Guide](AGENTS.md)** - AI agent components and patterns *(coming soon)*
201203

202204
## Background
203205

docs/ONBOARDING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,8 @@ Each component needs a comprehensive README.md with:
238238
- **Contributing**: [CONTRIBUTING.md](CONTRIBUTING.md)
239239
- **Testing**: [TESTING.md](TESTING.md)
240240
- **Governance**: [GOVERNANCE.md](GOVERNANCE.md)
241+
- **Best Practices**: [BESTPRACTICES.md](BESTPRACTICES.md) *(coming soon)*
242+
- **Agents**: [AGENTS.md](AGENTS.md) *(coming soon)*
241243
- **Community**: [#kubeflow-pipelines Slack](https://kubeflow.slack.com/channels/kubeflow-pipelines)
242244
- **Issues**: [GitHub Issues](https://github.com/kubeflow/pipeline-components/issues) for bugs and questions
243245

0 commit comments

Comments
 (0)