Skip to content

Commit

Permalink
chore: add bug report and feature request templates (#81)
Browse files Browse the repository at this point in the history
Added bug report and feature request templates to improve the issue creation process. These templates provide a standardized structure for reporting bugs and requesting new features, making it easier for contributors to provide clear and concise information. This will help streamline the issue triage and resolution process.

The bug report template includes sections for describing the bug, steps to reproduce, actual and expected behavior, screenshots, and additional information. The feature request template includes sections for describing the requested feature, motivation, proposed solution, and additional context.

This commit follows the established commit message convention of starting with a verb in the imperative form, followed by a brief description of the change. It also includes a type prefix ("feat") to indicate that it is a new feature.

closes #80
  • Loading branch information
jooyoungseo authored Aug 18, 2024
1 parent 483a075 commit 5af72c2
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: "fix(): address an issue where "
labels: bug
assignees: ''
---

# Bug Report

## Description
<!-- Please provide a clear and concise description of the bug. -->

## Steps to Reproduce

1. Step 1
2. Step 2
3. Step 3

## Actual Behavior
<!-- Please describe what actually happened. -->

## Expected Behavior
<!-- Please describe what you expected to happen. -->

## Screenshots
<!-- If applicable, add screenshots to help explain the problem. -->
<!-- You can take a gif animation screenshot very easily without any additional installation by using this browser-based tool: -->
<!-- https://gifcap.dev -->

## Environment
- Operating System: [e.g. Windows 10]
- Browser: [e.g. Chrome, Firefox]
- Version: [e.g. 1.0.0]

## Additional Information
<!-- Add any other relevant information about the problem here. -->
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Feature request
about: Suggest an idea for this project
title: "feat: "
labels: enhancement
assignees: ''
---

# Feature Request

## Description

Please provide a clear and concise description of the feature you would like to request.

## Motivation

Explain why this feature is important and how it would benefit the project.

## Proposed Solution

Outline your proposed solution or any ideas you have for implementing this feature.

## Additional Context

<!-- Add any additional context or screenshots about the feature request here. -->
<!-- If applicable, add screenshots to help explain the problem. -->
<!-- You can take a gif animation screenshot very easily without any additional installation by using this browser-based tool: -->
<!-- https://gifcap.dev -->


## Checklist

- [ ] I have searched for similar feature requests and confirmed that this is a new request.
- [ ] I have provided a clear and concise description of the feature.
- [ ] I have explained the motivation behind this feature request.
- [ ] I have outlined a proposed solution or ideas for implementing this feature.
- [ ] I have provided any additional context or screenshots if applicable.
53 changes: 53 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!-- Suggested PR Title: [feat/fix/refactor/perf/test/ci/docs/chore] brief description of the change -->
<!-- Please follow Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0/ -->

## Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

## Type of Change

- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update

## Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my 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
- [ ] Any dependent changes have been merged and published in downstream modules

# Pull Request

## Description
<!-- Provide a brief description of the changes made in this pull request. -->

## Related Issues
<!-- Specify any related issues or tickets that this pull request addresses. -->

## Changes Made
<!-- Describe the specific changes made in this pull request. -->

## Screenshots (if applicable)
<!-- Include any relevant screenshots or images to help visualize the changes. -->
<!-- You can take a gif animation screenshot very easily without any additional installation by using this browser-based tool: -->
<!-- https://gifcap.dev -->

## Checklist
<!-- Please select all applicable options. -->
<!-- To select your options, please put an 'x' in the all boxes that apply. -->

- [ ] I have read the [Contributor Guidelines](../CONTRIBUTING.md).
- [ ] I have performed a self-review of my own code and ensured it follows the project's coding standards.
- [ ] I have tested the changes locally following `ManualTestingProcess.md`, and all tests related to this pull request pass.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have updated the documentation, if applicable.
- [ ] I have added appropriate unit tests, if applicable.

## Additional Notes
<!-- Add any additional notes or comments here. -->
<!-- Template credit: This pull request template is based on Embedded Artistry {https://github.com/embeddedartistry/templates/blob/master/.github/PULL_REQUEST_TEMPLATE.md}, Clowder {https://github.com/clowder-framework/clowder/blob/develop/.github/PULL_REQUEST_TEMPLATE.md}, and TalAter {https://github.com/TalAter/open-source-templates} templates. -->

0 comments on commit 5af72c2

Please sign in to comment.