Skip to content

Commit 23337a1

Browse files
amrit110amrit110
committed
Initial commit
1 parent db63fdf commit 23337a1

19 files changed

+2489
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Report a bug to help us improve the project
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
## Bug Description
11+
12+
<!-- A clear and concise description of what the bug is -->
13+
14+
## Steps to Reproduce
15+
16+
1.
17+
2.
18+
3.
19+
20+
**Code snippet (if applicable):**
21+
```python
22+
# Your code here
23+
```
24+
25+
## Expected Behavior
26+
27+
<!-- A clear description of what you expected to happen -->
28+
29+
## Actual Behavior
30+
31+
<!-- A clear description of what actually happened -->
32+
33+
## Environment
34+
35+
- **Component:** [API | Core functionality | Any]
36+
- **OS:** [Windows | MacOS | Linux]
37+
- **Python Version:**
38+
39+
## Screenshots/Logs
40+
41+
<!-- If applicable, add screenshots or error logs -->
42+
43+
## Additional Context
44+
45+
<!-- Add any other context about the problem here -->
46+
47+
## Possible Solution
48+
49+
<!-- If you have suggestions on how to fix the bug, please describe them here -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Discussion
4+
url: https://github.com/VectorInstitute/aieng-template-uv/discussions
5+
about: Ask questions or discuss ideas with the community
6+
- name: 📖 Documentation
7+
url: https://github.com/VectorInstitute/aieng-template-uv#readme
8+
about: Check the documentation for setup and usage guides

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: ✨ Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
## Problem Statement
11+
12+
<!-- Is your feature request related to a problem? Describe the problem or use case -->
13+
14+
## Proposed Solution
15+
16+
<!-- A clear description of what you want to happen -->
17+
18+
## Alternative Solutions
19+
20+
<!-- Describe any alternative solutions or features you've considered -->
21+
22+
## Use Cases
23+
24+
<!-- Describe specific use cases where this feature would be valuable -->
25+
-
26+
-
27+
-
28+
29+
## Implementation Ideas
30+
31+
<!-- If you have ideas about how this could be implemented, describe them here -->
32+
33+
## Component Impact
34+
35+
<!-- Which parts of the system would this feature affect? -->
36+
- [ ] API
37+
- [ ] Core functionality
38+
- [ ] Docker/Infrastructure
39+
- [ ] Documentation
40+
- [ ] Any other part of the system
41+
42+
## Additional Context
43+
44+
<!-- Add any other context, mockups, or screenshots about the feature request here -->
45+
46+
## Priority
47+
48+
<!-- How important is this feature to you? -->
49+
- [ ] Nice to have
50+
- [ ] Would be helpful
51+
- [ ] Important for my use case
52+
- [ ] Critical/blocking

‎.github/bot-assets/BOT_IDENTITY.md‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
# AI Engineering Maintenance Bot Identity
2+
3+
This document defines the visual and textual identity of the **AI Engineering Maintenance Bot** (aieng-bot-maintain).
4+
5+
## Bot Name
6+
**AI Engineering Maintenance Bot** (short: `aieng-bot-maintain`)
7+
8+
## Purpose
9+
Automated maintenance bot for Vector Institute repositories that:
10+
- Auto-merges Dependabot PRs when all checks pass
11+
- Automatically fixes common issues in failing Dependabot PRs
12+
- Maintains code quality and security standards
13+
14+
## Visual Identity
15+
16+
### Avatar Specifications
17+
The bot should have a professional, technical avatar that represents:
18+
- **Theme**: AI + Engineering + Maintenance
19+
- **Style**: Modern, clean, geometric
20+
- **Colors**: Vector Institute brand colors (if available), or:
21+
- Primary: Deep blue (#1E3A8A) - representing reliability and trust
22+
- Secondary: Green (#10B981) - representing automated fixes and success
23+
- Accent: Orange (#F59E0B) - representing active maintenance
24+
- **Elements**: Consider incorporating:
25+
- A wrench or gear (maintenance)
26+
- A robot or AI symbol
27+
- Code brackets or technical elements
28+
- Vector Institute logo elements (if permitted)
29+
30+
### Avatar Design Concepts
31+
32+
#### Option 1: Minimalist Robot
33+
A simple, geometric robot icon with:
34+
- Circular head with friendly "eyes" (two dots or simple shapes)
35+
- Wrench or tools as "arms" or accessories
36+
- Clean lines, flat design
37+
- Primary colors: blue and green
38+
39+
#### Option 2: Abstract Technical
40+
An abstract representation combining:
41+
- Overlapping geometric shapes suggesting AI/automation
42+
- Subtle gear or mechanical elements
43+
- Gradient from blue to green
44+
- Modern, professional appearance
45+
46+
#### Option 3: Badge Style
47+
A circular badge design with:
48+
- "AI" or robot symbol in the center
49+
- Wrench or tool crossed behind
50+
- Border with subtle technical patterns
51+
- Vector Institute affiliation indication
52+
53+
### Creating the Avatar
54+
To create the avatar, you can:
55+
56+
1. **Use AI Image Generation** (recommended):
57+
- Tool: DALL-E, Midjourney, or Stable Diffusion
58+
- Prompt example: "Minimalist flat design robot icon for software maintenance bot, geometric shapes, blue and green colors, wrench symbol, professional tech company style, circular avatar, clean lines, white background"
59+
60+
2. **Use Design Tools**:
61+
- Figma, Adobe Illustrator, or Canva
62+
- Start with geometric shapes
63+
- Keep it simple and scalable
64+
- Export as PNG (512x512px minimum) or SVG
65+
66+
3. **Commission a Designer**:
67+
- Provide these specifications
68+
- Request multiple format exports (PNG, SVG)
69+
- Ensure rights for use in open-source context
70+
71+
### Current Avatar
72+
The bot uses the **Vector Institute logo** as its avatar:
73+
- `.github/bot-assets/avatar.webp` - WebP format (primary)
74+
- `.github/bot-assets/avatar.svg` - SVG vector format
75+
76+
This ensures consistent branding with Vector Institute across all bot interactions.
77+
78+
## Textual Identity
79+
80+
### Bot Signature
81+
All bot comments, commits, and messages should include this signature:
82+
83+
```markdown
84+
---
85+
🤖 *AI Engineering Maintenance Bot - Maintaining Vector Institute Repositories built by AI Engineering*
86+
```
87+
88+
### Git Commit Identity
89+
```
90+
Name: aieng-bot-maintain[bot]
91+
Email: aieng-bot@vectorinstitute.ai
92+
```
93+
94+
### Co-author Tag
95+
```
96+
Co-authored-by: AI Engineering Maintenance Bot <aieng-bot@vectorinstitute.ai>
97+
```
98+
99+
## Communication Style
100+
101+
### Tone
102+
- **Professional** but friendly
103+
- **Clear and concise**
104+
- **Informative** without being verbose
105+
- **Helpful** and action-oriented
106+
107+
### Message Patterns
108+
109+
#### Success Messages
110+
```
111+
✅ [Action completed successfully]
112+
113+
[Brief explanation of what was done]
114+
115+
---
116+
🤖 *AI Engineering Maintenance Bot - Maintaining Vector Institute Repositories built by AI Engineering*
117+
```
118+
119+
#### Working/In-Progress Messages
120+
```
121+
🔧 [Action in progress]
122+
123+
[Brief explanation of what's being done]
124+
125+
---
126+
🤖 *AI Engineering Maintenance Bot - Maintaining Vector Institute Repositories built by AI Engineering*
127+
```
128+
129+
#### Warning/Error Messages
130+
```
131+
⚠️ [Issue description]
132+
133+
[Explanation of the issue]
134+
[What actions can be taken]
135+
136+
---
137+
🤖 *AI Engineering Maintenance Bot - Maintaining Vector Institute Repositories built by AI Engineering*
138+
```
139+
140+
#### Informational Messages
141+
```
142+
ℹ️ [Information title]
143+
144+
[Details]
145+
146+
---
147+
🤖 *AI Engineering Maintenance Bot - Maintaining Vector Institute Repositories built by AI Engineering*
148+
```
149+
150+
### Emoji Usage
151+
Use emojis sparingly and consistently:
152+
- ✅ Success, approval, completion
153+
- ❌ Failure, error, rejection
154+
- 🔧 Working on fixes, maintenance
155+
- ⚠️ Warning, caution needed
156+
- ℹ️ Information, FYI
157+
- 🎉 Celebration (for merges)
158+
- 🤖 Bot signature
159+
160+
## GitHub Profile Setup
161+
162+
### Profile Configuration (if using GitHub App)
163+
- **Name**: AI Engineering Maintenance Bot
164+
- **Username**: `aieng-bot-maintain`
165+
- **Description**: Automated maintenance bot for Vector Institute AI Engineering repositories. Auto-merges PRs and fixes common issues.
166+
- **Website**: Link to this repository or Vector Institute website
167+
- **Avatar**: Use the designed avatar image
168+
169+
### Repository Configuration
170+
In the repository settings (`.github/settings.yml` if using probot/settings):
171+
```yaml
172+
repository:
173+
name: aieng-bot-maintain
174+
description: AI Engineering Maintenance Bot for Vector Institute repositories
175+
homepage: https://github.com/VectorInstitute/aieng-bot-maintain
176+
topics:
177+
- automation
178+
- github-actions
179+
- dependabot
180+
- maintenance-bot
181+
- ai-engineering
182+
```
183+
184+
## Branding Consistency
185+
186+
### Across All Platforms
187+
Ensure consistency in:
188+
1. **Naming**: Always use "AI Engineering Maintenance Bot" or "aieng-bot-maintain"
189+
2. **Avatar**: Same image across GitHub, documentation, etc.
190+
3. **Signature**: Always include the standard signature in bot communications
191+
4. **Email**: Always use `aieng-bot@vectorinstitute.ai`
192+
5. **Color scheme**: Maintain the blue/green/orange palette in any visual materials
193+
194+
## License and Attribution
195+
- The bot identity should reflect that it's maintained by Vector Institute's AI Engineering team
196+
- All bot communications should maintain professional standards
197+
- Attribution to Vector Institute should be clear and consistent

‎.github/bot-assets/avatar-placeholder.txt‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Bot Avatar Placeholder
2+
3+
This directory should contain the bot avatar images.
4+
5+
## Required Files
6+
- `avatar.png` - Main avatar (512x512px minimum)
7+
- `avatar-small.png` - Thumbnail (128x128px)
8+
- `avatar.svg` - Vector version (optional)
9+
10+
## Creation Instructions
11+
See BOT_IDENTITY.md for design specifications.
12+
13+
Generate avatar using:
14+
1. AI image generation tools (DALL-E, Midjourney)
15+
2. Design tools (Figma, Adobe Illustrator)
16+
3. Commission from a designer
17+
18+
## Recommended Prompt for AI Generation
19+
"Minimalist flat design robot icon for software maintenance bot, geometric shapes, blue and green colors, wrench symbol, professional tech company style, circular avatar, clean lines, white background, 512x512"

0 commit comments

Comments
 (0)