Skip to content

Commit f9fa2a3

Browse files
Initial commit: Engineer Solutions - Placeholder
0 parents  commit f9fa2a3

File tree

164 files changed

+35330
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

164 files changed

+35330
-0
lines changed

.github/CODEOWNERS

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# CODEOWNERS file for AI Infrastructure Engineer Solutions
2+
#
3+
# This file defines who owns different parts of the repository.
4+
# When a PR is opened, these users/teams will be automatically requested for review.
5+
#
6+
# More info: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
7+
8+
# Default owners for everything in the repo
9+
# Replace with actual GitHub usernames or team names
10+
* @ai-infra-curriculum
11+
12+
# Project-specific owners
13+
/projects/project-01-basic-model-serving/ @ai-infra-curriculum
14+
/projects/project-02-mlops-pipeline/ @ai-infra-curriculum
15+
/projects/project-03-llm-deployment/ @ai-infra-curriculum
16+
17+
# Documentation owners
18+
/docs/ @ai-infra-curriculum
19+
*.md @ai-infra-curriculum
20+
/guides/ @ai-infra-curriculum
21+
22+
# CI/CD and infrastructure
23+
/.github/ @ai-infra-curriculum
24+
/kubernetes/ @ai-infra-curriculum
25+
/monitoring/ @ai-infra-curriculum
26+
docker-compose.yml @ai-infra-curriculum
27+
Dockerfile @ai-infra-curriculum
28+
29+
# Configuration files
30+
requirements.txt @ai-infra-curriculum
31+
requirements-dev.txt @ai-infra-curriculum
32+
.env.example @ai-infra-curriculum
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or issue with the solutions
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## Affected Project
13+
- [ ] Project 01: Basic Model Serving
14+
- [ ] Project 02: MLOps Pipeline
15+
- [ ] Project 03: LLM Deployment
16+
- [ ] Repository/Documentation
17+
- [ ] Other (please specify)
18+
19+
## Steps to Reproduce
20+
1. Go to '...'
21+
2. Run command '...'
22+
3. See error
23+
24+
## Expected Behavior
25+
What you expected to happen.
26+
27+
## Actual Behavior
28+
What actually happened.
29+
30+
## Environment
31+
**Operating System:**
32+
- [ ] Linux (specify distro and version)
33+
- [ ] macOS (specify version)
34+
- [ ] Windows (specify version)
35+
36+
**Deployment Method:**
37+
- [ ] Local (Python virtual environment)
38+
- [ ] Docker / Docker Compose
39+
- [ ] Kubernetes (specify K8s version)
40+
- [ ] Cloud provider (specify: AWS/GCP/Azure)
41+
42+
**Software Versions:**
43+
- Python version:
44+
- Docker version:
45+
- Kubernetes version (if applicable):
46+
- GPU/CUDA version (if applicable):
47+
48+
## Error Logs
49+
```
50+
Paste relevant error logs here
51+
```
52+
53+
## Screenshots
54+
If applicable, add screenshots to help explain your problem.
55+
56+
## Additional Context
57+
Add any other context about the problem here.
58+
59+
## Possible Solution
60+
If you have ideas on how to fix this, please share.
61+
62+
## Checklist
63+
- [ ] I have searched existing issues to avoid duplicates
64+
- [ ] I have read the project's TROUBLESHOOTING.md
65+
- [ ] I have provided all requested information
66+
- [ ] I can reproduce this issue consistently
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Documentation Issue
3+
about: Report missing, unclear, or incorrect documentation
4+
title: '[DOCS] '
5+
labels: documentation
6+
assignees: ''
7+
---
8+
9+
## Documentation Issue
10+
Describe the documentation issue you've encountered.
11+
12+
## Location
13+
Which document or section is affected?
14+
- File path:
15+
- Section/heading:
16+
17+
## Issue Type
18+
- [ ] Missing documentation
19+
- [ ] Unclear or confusing explanation
20+
- [ ] Incorrect information
21+
- [ ] Broken links
22+
- [ ] Outdated content
23+
- [ ] Typo or formatting issue
24+
- [ ] Other (please specify)
25+
26+
## Current Content
27+
Quote or describe the current documentation (if applicable).
28+
29+
## Suggested Improvement
30+
How do you think this should be improved?
31+
32+
## Additional Context
33+
Any other context about the documentation issue.
34+
35+
## Checklist
36+
- [ ] I have checked for duplicate issues
37+
- [ ] I have provided specific location information
38+
- [ ] I have suggested improvements (if applicable)
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an enhancement or new feature
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
A clear and concise description of the feature you'd like to see.
11+
12+
## Motivation
13+
Why is this feature important? What problem does it solve?
14+
15+
## Affected Project(s)
16+
- [ ] Project 01: Basic Model Serving
17+
- [ ] Project 02: MLOps Pipeline
18+
- [ ] Project 03: LLM Deployment
19+
- [ ] Repository/Documentation
20+
- [ ] All projects
21+
- [ ] Other (please specify)
22+
23+
## Proposed Solution
24+
Describe how you think this feature should work.
25+
26+
## Alternative Solutions
27+
Have you considered any alternative approaches?
28+
29+
## Example Usage
30+
If applicable, provide examples of how this feature would be used.
31+
32+
```python
33+
# Example code showing how the feature might be used
34+
```
35+
36+
## Educational Value
37+
How does this feature improve the learning experience or demonstrate important concepts?
38+
39+
## Implementation Complexity
40+
How complex do you think this feature would be to implement?
41+
- [ ] Simple (a few hours)
42+
- [ ] Moderate (a few days)
43+
- [ ] Complex (a week or more)
44+
- [ ] Not sure
45+
46+
## Related Resources
47+
- Links to similar implementations
48+
- Documentation references
49+
- Blog posts or papers
50+
51+
## Checklist
52+
- [ ] I have searched existing issues and feature requests
53+
- [ ] This feature aligns with the project's educational goals
54+
- [ ] I would be willing to contribute to implementing this feature
55+
- [ ] I have provided clear use cases and examples

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Pull Request
2+
3+
## Description
4+
Provide a clear and concise description of your changes.
5+
6+
## Type of Change
7+
- [ ] Bug fix (non-breaking change that fixes an issue)
8+
- [ ] New feature (non-breaking change that adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] Documentation update
11+
- [ ] Performance improvement
12+
- [ ] Code refactoring
13+
- [ ] Test additions or improvements
14+
- [ ] CI/CD improvements
15+
16+
## Affected Project(s)
17+
- [ ] Project 01: Basic Model Serving
18+
- [ ] Project 02: MLOps Pipeline
19+
- [ ] Project 03: LLM Deployment
20+
- [ ] Repository root / Documentation
21+
- [ ] Guides (debugging, optimization, production-readiness)
22+
- [ ] CI/CD workflows
23+
24+
## Changes Made
25+
List the main changes made in this PR:
26+
-
27+
-
28+
-
29+
30+
## Testing
31+
Describe the testing you performed:
32+
33+
- [ ] Unit tests added/updated and passing
34+
- [ ] Integration tests passing
35+
- [ ] Manual testing performed
36+
- [ ] Documentation tested for accuracy
37+
- [ ] Changes tested in Docker environment
38+
- [ ] Changes tested in Kubernetes environment (if applicable)
39+
40+
**Test commands run:**
41+
```bash
42+
# Add commands you used for testing
43+
```
44+
45+
## Screenshots
46+
If applicable, add screenshots to help explain your changes.
47+
48+
## Documentation
49+
- [ ] README updated (if needed)
50+
- [ ] Documentation files updated (if needed)
51+
- [ ] Code comments added/updated
52+
- [ ] CHANGELOG updated (if applicable)
53+
54+
## Checklist
55+
Please ensure your PR meets these requirements:
56+
57+
### Code Quality
58+
- [ ] Code follows the project's style guidelines
59+
- [ ] Self-review performed
60+
- [ ] Code is properly commented (complex sections)
61+
- [ ] No linting errors
62+
- [ ] Type hints added (for Python)
63+
- [ ] Docstrings added/updated
64+
65+
### Testing
66+
- [ ] All existing tests pass
67+
- [ ] New tests added for new functionality
68+
- [ ] Test coverage maintained or improved
69+
- [ ] No new warnings generated
70+
71+
### Documentation
72+
- [ ] Documentation updated to reflect changes
73+
- [ ] STEP_BY_STEP.md updated (if needed)
74+
- [ ] API documentation updated (if applicable)
75+
- [ ] Comments added for complex logic
76+
77+
### Security
78+
- [ ] No sensitive data (passwords, API keys) in code
79+
- [ ] No security vulnerabilities introduced
80+
- [ ] Dependencies updated (if applicable)
81+
- [ ] Security scanning passed
82+
83+
### Breaking Changes
84+
- [ ] No breaking changes
85+
- [ ] Breaking changes documented and justified
86+
- [ ] Migration guide provided (if breaking changes)
87+
88+
## Related Issues
89+
Closes #(issue number)
90+
Relates to #(issue number)
91+
92+
## Additional Notes
93+
Add any additional notes, context, or considerations for reviewers.
94+
95+
## Deployment Notes
96+
Any special considerations for deploying these changes?
97+
98+
## Reviewer Notes
99+
@reviewer-username - Please pay special attention to [specific area]
100+
101+
---
102+
103+
**For Maintainers:**
104+
- [ ] Changes reviewed and approved
105+
- [ ] Tests passing
106+
- [ ] Documentation adequate
107+
- [ ] Ready to merge

0 commit comments

Comments
 (0)