Skip to content

.github file upgrade #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tmikula-dev merged 1 commit into from
Dec 12, 2025
Merged

.github file upgrade #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop

This file was deleted.

82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Bug Report
description: Create a report to help us improve
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Please supply complete reproduction details to speed up resolution.

- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: Tell us what went wrong.
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior OR commands run
placeholder: |
1. Go to '...'
2. Click on '....'
3. Enter value '...'
4. See error
validations:
required: true

- type: textarea
id: expected-state
attributes:
label: Expected state
description: A clear and concise description of what you expected to happen
placeholder: What should have happened?
validations:
required: true

- type: dropdown
id: severity
attributes:
label: Impact / Severity
description: Level of impact
options:
- Blocker
- High
- Medium
- Low
validations:
required: true

- type: textarea
id: evidence
attributes:
label: Attachments / Evidence
description: Logs, screenshots, traces.
placeholder: Paste relevant excerpts.
validations:
required: false

- type: textarea
id: os-browser-version
attributes:
label: Desktop
description: What are your OS, browser, and version?
placeholder: |
OS: e.g., Windows 10, macOS 11.2, Ubuntu 20.04
Browser: e.g., Chrome, Safari, Firefox
Version: e.g., 22
validations:
required: false

- type: textarea
id: related
attributes:
label: Related / References
description: Link other issues/PRs.
placeholder: "#456, #789"
validations:
required: false
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/devops_task.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: DevOps Task
description: Issue template for a task about setting up the project. Usually not touching the codebase.
labels: ["infrastructure"]
body:
- type: markdown
attributes:
value: |
A clear and concise description of the task to be done.

- type: textarea
id: task-description
attributes:
label: The task
description: Short description of the task
placeholder: Describe what needs to be done
validations:
required: true
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_task.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Documentation
description: Update or create technical or operational documentation
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Provide clear purpose and scope for the documentation update.

- type: input
id: summary
attributes:
label: Summary
description: Short description of the documentation update.
placeholder: e.g. Add onboarding guide for new microservice
validations:
required: true

- type: textarea
id: current-state
attributes:
label: Current State (If Updating)
description: Briefly describe existing content or gap.
placeholder: Existing runbook lacks failure recovery steps.
validations:
required: false

- type: textarea
id: proposed-changes
attributes:
label: Proposed Changes
description: Key additions, removals, or restructures.
placeholder: Add section on X; remove deprecated Y.
validations:
required: true

- type: textarea
id: dependencies
attributes:
label: Dependencies / References
description: Link related issues, PRs, external standards.
placeholder: "#123, ADR-7, compliance doc link."
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other information about the documentation update here.
placeholder: Add any other relevant context.
validations:
required: false
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/epic_task.md
View file
Open in desktop

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/epic_task.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Epic
description: A larger task consisting of more deliverables.
labels: ["epic"]
body:
- type: markdown
attributes:
value: |
Use this template for large initiatives with multiple child issues.

- type: textarea
id: background
attributes:
label: Background
description: High-level narrative and intended outcomes.
placeholder: Platform modernization initiative.
validations:
required: true

- type: textarea
id: goals
attributes:
label: Goals
description: Bullet list of measurable goals.
placeholder: What do we want to accomplish?
validations:
required: true

- type: textarea
id: subtasks
attributes:
label: Subtasks
description: List of planned child issues.
placeholder: |
- [ ] #123 Subtask 1
- [ ] #223 Subtask 2
- [ ] #323 Subtask 3
validations:
required: false

- type: textarea
id: references
attributes:
label: Related / References
description: Docs, ADRs, previous epics links.
placeholder: ADR-12 link, design doc.
validations:
required: false
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop

This file was deleted.

65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Feature Request
description: Suggest an idea for this project.
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thank you for suggesting an improvement. Please provide clear, actionable detail.
- type: textarea
id: feature-description
attributes:
label: Feature Description
description: A clear and concise description of what you want to happen.
placeholder: Describe the feature you'd like to see.
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem / Opportunity
description: What user/business problem does this solve? Who benefits?
placeholder: Current pain, limitation, or missed opportunity.
validations:
required: true

- type: textarea
id: acceptance
attributes:
label: Acceptance Criteria
description: Clear, testable outcomes. Use bullet points.
placeholder: |
1. User can...
2. API returns...
3. Performance within...
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: High-level approach. Mention alternatives if considered.
placeholder: Describe the direction without full implementation detail.
validations:
required: false

- type: textarea
id: dependencies
attributes:
label: Dependencies / Related
description: Link related issues, epics, or external docs.
placeholder: "#123, #456, ADR link"
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other information or screenshots about the feature request here
placeholder: Add any other relevant context or screenshots
validations:
required: false
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/operative_task.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Operative / Management Task
description: General-purpose template for operational, management, and non-development tasks
labels: ["operative"]
body:
- type: markdown
attributes:
value: |
Use this flexible template for operational, management, planning, or administrative tasks.

- type: input
id: summary
attributes:
label: Task Summary
description: Brief one-line description of the task
placeholder: e.g., Organize Q2 planning meeting, Update team guidelines.
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: Detailed description of what needs to be done and why
placeholder: Provide context, background, and objectives for this task
validations:
required: true

- type: textarea
id: objectives
attributes:
label: Objectives / Goals
description: What are we trying to achieve?
placeholder: |
- Objective 1
- Objective 2
validations:
required: false

- type: input
id: deadline
attributes:
label: Deadline / Target Date
description: When should this be completed?
placeholder: YYYY-MM-DD or "End of Sprint 5"
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other relevant information, links, or attachments
placeholder: Links to documents, previous discussions, related materials
validations:
required: false
Comment on lines +1 to +55
Copy link

@coderabbitai coderabbitai bot Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Ensure the operative label exists; consider tightening “Deadline / Target Date” guidance.

  • Line 3: If the operative label doesn’t exist in the repo, it won’t be applied (and users won’t notice). Consider adding/standardizing it (or choosing an existing label).
  • Line 39-46: Since issue forms can’t enforce date formats, consider clarifying the placeholder/help text to prefer ISO YYYY-MM-DD only (or rename to “Target timeframe” if you want flexibility).
🤖 Prompt for AI Agents 
.github/ISSUE_TEMPLATE/operative_task.yml lines 1-55: the template references a
non-guaranteed "operative" label and provides ambiguous deadline guidance;
update the repository or template so the label is reliable (either create/add
the "operative" label to the repo or replace it with an existing standardized
label and document its use), and tighten the deadline field guidance by changing
the placeholder/description to prefer ISO format "YYYY-MM-DD" only (or
alternatively rename the field to "Target timeframe" if flexibility is intended)
so users get clear instructions.

Loading