Skip to content

Commit

Permalink
[enhancement] Add new issue templates (#2903)
Browse files Browse the repository at this point in the history
* Create documentation.md

* Create RFC.md

* Create feature_request.md

* Create question.md

* Update RFC.md

* Update documentation.md

* Update bug_report.md

* Delete .github/ISSUE_TEMPLATE/question.md

* Update .github/ISSUE_TEMPLATE/bug_report.md

Co-authored-by: Nikolay Petrov <[email protected]>

---------

Co-authored-by: Nikolay Petrov <[email protected]>
  • Loading branch information
icfaust and napetrov authored Sep 24, 2024
1 parent af53117 commit 890d98f
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 3 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/RFC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: RFC for new interface
about: Use this template to request new functionality or change the behavior of the library
title: ''
labels: 'RFC'
assignees: ''
---

**Summary**
Include a short summary of the request. Sections below provide guidance on
what factors are considered important.

**Problem statement**
Describe the problem you are trying to solve with a reasonable level of detail.

**Details**
* The definition of the function including interface and semantics. Please include how this
interface will be extendable for different hardware implementations.
* What existing libraries have implementation of this function and can be used
under oneDAL interface.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Describe what your are expecting from steps above
If applicable, add output/screenshots to help explain your problem.

**Environment:**
- OS: [e.g. Ubuntu 18.04]
- Compiler: [e.g. GCC9.2]
- Version: [e.g. 2019 Update 4]
- OS: [e.g. Ubuntu 22.04]
- Compiler: [e.g. GCC12.1]
- Version: [e.g. 2025.1]
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Request a documentation change
about: Use this template to report documentation issue or request documentation changes
title: ''
labels: 'documentation'
assignees: ''
---

**Summary**
Include a short summary of the issue or request. Sections below provide
guidance on what factors are considered important for a documentation
issue.

**URLs**
Include pointers to documents that are impacted.

**Additional details**
Please provide a detailed description of the expected changes in documentation
and any suggestions that you may have.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Request a feature
about: Use this template to request new functionality or change the behavior of the library
title: ''
labels: 'new feature'
assignees: ''
---

**Summary**
Include a short summary of the request.

See the sections below for factors important for a feature request.

**Problem Statement**
Describe the problem you want to solve with a reasonable level of detail.

**Preferred Solution**
Provide your ideas regarding problem solutions.

0 comments on commit 890d98f

Please sign in to comment.