Skip to content

Commit

Permalink
Merge pull request #31 from ahasunos/ci/enable-templating
Browse files Browse the repository at this point in the history
ci: add templates for pr and issues
  • Loading branch information
ahasunos authored Sep 6, 2024
2 parents b37a2f7 + fbc99e2 commit 166bbda
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] "
labels: bug
---
**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links: []
issue_templates:
- name: Bug Report
description: Report a bug or issue with the system.
labels: bug
file: bug_report.md
- name: Task
description: Create or track tasks that need to be completed.
labels: task
file: task.md
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Feature/Task
about: Request a new feature or task to be completed
title: "[Feature] "
labels: feature, task
---

## Summary

**What is the task or feature?**
Briefly describe what needs to be done.

## Objective

**Why is this important?**
Explain the purpose and why this task or feature is needed.

## Approach

**How should this be implemented?**
Provide a high-level overview of how you think this should be tackled (e.g., specific technology, steps, etc.).

## Acceptance Criteria

- [ ] Task 1: Clear description of the first task to complete
- [ ] Task 2: Clear description of the second task to complete
- [ ] Task 3: Clear description of the third task to complete

## Additional Information

**Priority**: Low | Medium | High

**Dependencies**: Are there any other tasks, features, or issues that need to be completed first? List them here.

**Notes**: Any other context, information, or technical details relevant to this task.
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

## Related Issue
Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

## Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings

0 comments on commit 166bbda

Please sign in to comment.