Skip to content

Commit

Permalink
feat(github): Create issue templates
Browse files Browse the repository at this point in the history
Resolves #6540.

Signed-off-by: Sebastian Schuberth <[email protected]>
  • Loading branch information
sschuberth committed Apr 28, 2024
1 parent cfee6f1 commit 50a2428
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 0 deletions.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
name: Bug Report
about: I want to report a bug that I am facing.
title: ''
labels: 'bug'

---
### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

Steps to reproduce the behavior:

1. First do '...'
2. Then do '...'
3. Finally do '...'
4. See error

### Expected behavior

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

### Console / log output

Add console and / or log output that shows the error and additional context.
No screenshots of plain text please, to keep text searchable.

```
<copy & paste output to here>
```

### Environment

Output of the `ort requirements` command:

```
<copy & paste output to here>
```

*Or* manually specify:

* ORT version: [e.g. 22.1.0]
* Java version: [e.g. 17]
* OS: [e.g. Linux]

*And* specify (relevant parts of) your ORT configuration (`config.yml`):

```
<copy & paste output to here>
```

### Additional context

Add any other context about the problem here.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
contact_links:
- name: Discuss an Idea
about: Start a discussion or ask a longer question.
url: https://github.com/oss-review-toolkit/ort/discussions
- name: Ask a Question
about: Ask a quick question or just chat with the ORT community.
url: http://slack.oss-review-toolkit.org/
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Enhancement Proposal
about: I want to propose to enhance existing functionality.
title: ''
labels: 'enhancement'

---
### What is the existing functionality and how should it be enhanced?

A clear and concise description of what you propose to change and why it is an enhancement.

### What is the use-case for your enhancement?

A clear and concise description of which users would benefit from the enhancement.

### Alternatives you have considered

A clear and concise description of any alternative solutions you have considered.

### Additional context

Add any other context or screenshots about the enhancement proposal here.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature Request
about: I want to request a new feature that I find useful.
title: ''
labels: 'new feature'

---
### What is the feature you want to request?

A clear and concise description of what problem the feature addresses.

### Describe the solution you would like

A clear and concise description of what you want to happen.

### Alternatives you have considered

A clear and concise description of any alternative solutions you have considered.

### Additional context

Add any other context or screenshots about the feature request here.

0 comments on commit 50a2428

Please sign in to comment.