@@ -7,10 +7,16 @@ Welcome to the Kubeflow Pipelines Components Repository! This guide will get you
77- [ Prerequisites] ( #prerequisites )
88- [ Quick Setup] ( #quick-setup )
99- [ Development Workflow] ( #development-workflow )
10+ - [ 1. Create Feature Branch] ( #1-create-feature-branch )
11+ - [ 2. Develop Component or Pipeline] ( #2-develop-component-or-pipeline )
12+ - [ 3. Test and Submit] ( #3-test-and-submit )
13+ - [ 4. Commit Your Changes] ( #4-commit-your-changes )
14+ - [ 5. Push and Create Pull Request] ( #5-push-and-create-pull-request )
1015- [ Component Implementation] ( #component-implementation )
11- - [ Testing] ( #testing )
1216- [ Code Quality] ( #code-quality )
13- - [ Documentation] ( #documentation )
17+ - [ Quick Reference] ( #quick-reference )
18+ - [ Testing] ( #testing )
19+ - [ Documentation] ( #documentation )
1420- [ Getting Help] ( #getting-help )
1521- [ Next Steps] ( #next-steps )
1622- [ References] ( #references )
@@ -158,7 +164,6 @@ git push --set-upstream origin component/my_component
158164 - ** Testing** : How was this tested?
159165 - ** Checklist** : Complete the provided checklist
160166 - ** Related Issues** : Link to relevant issues
161- ```
162167
163168## Component Implementation
164169
@@ -242,28 +247,6 @@ COPY src/ .
242247ENTRYPOINT ["python", "main.py"]
243248```
244249
245- ## Testing
246-
247- * How to write and run tests to ensure your component works correctly.*
248-
249- Write comprehensive tests:
250-
251- ``` python
252- # tests/test_main.py
253- import pytest
254- from src.main import process_data
255-
256- def test_process_data ():
257- """ Test basic functionality."""
258- # Test implementation
259- assert True # Replace with actual tests
260-
261- def test_error_handling ():
262- """ Test error scenarios."""
263- with pytest.raises(ValueError ):
264- process_data(" invalid" , " output" )
265- ```
266-
267250## Code Quality
268251
269252* Tools and standards for maintaining high code quality and consistency.*
@@ -286,7 +269,29 @@ mypy .
286269pytest --cov=src --cov-report=html
287270```
288271
289- ## Documentation
272+ ### Testing
273+
274+ * How to write and run tests to ensure your component works correctly.*
275+
276+ Write comprehensive tests:
277+
278+ ``` python
279+ # tests/test_main.py
280+ import pytest
281+ from src.main import process_data
282+
283+ def test_process_data ():
284+ """ Test basic functionality."""
285+ # Test implementation
286+ assert True # Replace with actual tests
287+
288+ def test_error_handling ():
289+ """ Test error scenarios."""
290+ with pytest.raises(ValueError ):
291+ process_data(" invalid" , " output" )
292+ ```
293+
294+ ### Documentation
290295
291296* Requirements for documenting your component clearly and comprehensively.*
292297
@@ -301,7 +306,6 @@ Each component needs a comprehensive README.md with:
301306
302307* Resources and channels for getting support during your contribution journey.*
303308
304- - ** Setup Issues** : [ ONBOARDING.md] ( ONBOARDING.md ) (this guide)
305309- ** Contributing** : [ CONTRIBUTING.md] ( CONTRIBUTING.md )
306310- ** Testing** : [ TESTING.md] ( TESTING.md )
307311- ** Governance** : [ GOVERNANCE.md] ( GOVERNANCE.md )
0 commit comments