Skip to content

Commit

Permalink
Templates for issues and Pull requests
Browse files Browse the repository at this point in the history
- Changes made under openbsw/.github.
- Created bug_report.md and feature_request.md under ISSUE_TEMPLATE folder.
- Created PULL_REQUEST_TEMPLATE.md under PULL_REQUEST_TEMPLATE folder.
  • Loading branch information
SuhashiniNaik authored and marcmo committed Jan 20, 2025
1 parent dff736e commit e3d5991
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug Report
about: Report a reproducible issue
title: ''
labels: 'bug'
assignees: ''
---

**Describe the bug**
Include a clear and concise description of what the problem is.

**Steps to reproduce the bug**
Reproducing the issue is crucial for identifying and resolving the problem. Please include all
necessary code and detailed steps required to replicate the issue.

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

**Environment**
Operating System: [e.g Ubuntu 22.04, Windows 10]
Build System/Tools: [e.g GCC 11.4.0, CMake 3.25]

Please specify the exact environment or tools you’re using to help us better understand and
replicate the issue.

**Additional context**
Add any other context about the problem here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature Request
about: For feature requests. Please search for existing issues first. Also see CONTRIBUTING guidelines
title: ''
labels: 'enhancement'
assignees: ''
---

**Describe the feature**
Include a clear and detailed description of the feature and its intended use.

**Proposed Solution**
Describe your preferred solution, addressing:

- Details of the technical implementation
- Use cases
- Please specify if the feature is specific to an operating system, compiler,
or build system version
- Potential limitations or future considerations

**Additional context**
Add any other context or screenshots about the feature request here.
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Purpose of this PR
- [ ] Bugfix
- [ ] New Feature
- [ ] Documentation Update
- [ ] Other (Please specify)

**Description**
What does this PR do, Please provide an overview of the changes and their purpose.

**Related Issues**
Here is the issue related to this PR #[issue number] (if applicable)

**Breaking Changes**
- [ ] Yes
- [ ] No

If there are breaking changes, please explain what they are and how they may impact existing
functionality.

**Test Plan**
Please provide the steps for reviewers to test the changes.

**Regression Tests**
Have tests been added/updated? [ ] Yes [ ] No

0 comments on commit e3d5991

Please sign in to comment.