Skip to content

Commit

Permalink
Merge pull request #37 from DenisGithuku/35-implement-bug-and-feature…
Browse files Browse the repository at this point in the history
…-request-templates

Add pull request and issue templates
  • Loading branch information
DenisGithuku authored Aug 20, 2024
2 parents 614ddc4 + 94fa723 commit 4bfd64e
Show file tree
Hide file tree
Showing 4 changed files with 121 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Bug Report
about: Report a bug to help us improve
title: ''
labels: bug
assignees: ''

---

## Bug Title

<!-- Briefly describe the bug -->

### Description
<!-- Provide a detailed description of the bug. Include steps to reproduce, expected behavior, and actual behavior -->

### Steps to Reproduce
1. <!-- Step 1 -->
2. <!-- Step 2 -->
3. <!-- Step 3 -->

### Expected Behavior
<!-- Describe what you expected to happen -->

### Actual Behavior
<!-- Describe what actually happened -->

### Screenshots/Logs
<!-- If applicable, add screenshots to help explain the issue. Also include any relevant logs or error messages -->

### Environment Details
- **App Version:** <!-- e.g., 1.0.0 -->
- **Android Version:** <!-- e.g., Android 12 -->
- **Device:** <!-- e.g., Pixel 6 -->
- **Network:** <!-- e.g., Wi-Fi, 4G -->

### Possible Solution (Optional)
<!-- Suggest a fix or reason for the bug, if known -->

### Additional Context
<!-- Add any other context about the problem here, such as related issues, or anything else that might be helpful -->
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Feature Request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

## Feature Title

<!-- Briefly describe the feature you are requesting -->

### Problem Statement
<!-- What problem does this feature aim to solve? Why is it important? -->

### Proposed Solution
<!-- Describe your suggested solution or implementation details -->

### Use Cases
<!-- List specific scenarios where this feature would be useful -->

### Additional Context
<!-- Add any other context, screenshots, or references to related issues that might help in understanding the feature -->

### Alternatives Considered
<!-- If you considered any alternatives to your proposed solution, list them here and explain why they were not chosen -->

### Resources/References (Optional)
<!-- Include any links, documents, or references that provide additional information about the feature -->
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Feature Request
url: https://github.com/DenisGithuku/Bottan/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
about: Suggest a new feature or enhancement.
- name: Bug Report
url: https://github.com/DenisGithuku/Botan/issues/new?assignees=&labels=bug&template=bug_report.md&title=
about: Report a problem with the application.
42 changes: 42 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## Description

<!-- Please include a summary of the changes and the related issue. -->

## Related Issue

<!-- Link the issue related to this pull request, or specify that there is no related issue. -->

Fixes/Closes # <!-- If there is an issue that this PR resolves, include "Fixes #<issue_number>" or "Closes #<issue_number>". Otherwise, delete this line. -->

## 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)
- [ ] Documentation update

## Testing Details

<!-- Explain how the changes were tested and provide any relevant results. Include details about any edge cases, different environments tested, etc. -->

- [ ] Tests passed
- [ ] Tests added

## Checklist

<!-- Check all items that apply, add any missing items. -->

- [ ] My code follows the style guidelines of this project.
- [ ] I have performed a self-review of my own code.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have made corresponding changes to the documentation.
- [ ] My changes generate no new warnings.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] New and existing unit tests pass locally with my changes.
- [ ] Any dependent changes have been merged and published in downstream modules.

## Additional Context

<!-- Add any other context or screenshots about the pull request here. -->

0 comments on commit 4bfd64e

Please sign in to comment.