mirror of
https://github.com/DependencyTrack/dependency-track.git
synced 2025-10-19 07:53:18 +00:00
Migrate issue templates to issue forms (#1991)
* Migrate issue templates to issue forms This brings a bit more structure into how issues are reported, and is a lot more user-friendly. Also remove issue template for asking questions; Add various hints that issues should not be used to ask questions. Signed-off-by: nscuro <nscuro@protonmail.com> * Add pull request template Signed-off-by: nscuro <nscuro@protonmail.com> * Fix repo links in issue templates Signed-off-by: nscuro <nscuro@protonmail.com> * Fix links in issue templates; Refer to frontend repo; Add more versions Signed-off-by: nscuro <nscuro@protonmail.com> * Issue template cosmetics Signed-off-by: nscuro <nscuro@protonmail.com> * Fix repo link in PR template Signed-off-by: nscuro <nscuro@protonmail.com> * Update versions in defect report issue template Signed-off-by: nscuro <nscuro@protonmail.com> * Remove redundant info from `CONTRIBUTING.md` The fields we request for defect reports are now included in, and enforced by, the issue form. Signed-off-by: nscuro <nscuro@protonmail.com> * Clarify database server version field Signed-off-by: nscuro <nscuro@protonmail.com> Signed-off-by: nscuro <nscuro@protonmail.com>
This commit is contained in:
Niklas
GitHub
parent
37d8f28e82
commit
1dfaad1127
8 changed files with 225 additions and 76 deletions
23
.github/ISSUE_TEMPLATE/ask-a-question.md
vendored
23
.github/ISSUE_TEMPLATE/ask-a-question.md
vendored
|
|
@ -1,23 +0,0 @@
|
|||
---
|
||||
name: Ask a question - Use Slack instead - Do not create issues for questions
|
||||
about: Have a question about Dependency-Track?
|
||||
title: ''
|
||||
labels: question
|
||||
assignees: ''
|
||||
---
|
||||
All questions should be directed to the Dependency-Track Slack channel or to GitHub discussions
|
||||
Questions submitted through GitHub issues will be closed.
|
||||
|
||||
Slack channel
|
||||
- https://dependencytrack.org/slack
|
||||
|
||||
Slack invite
|
||||
- https://dependencytrack.org/slack/invite
|
||||
|
||||
GitHub discussions
|
||||
- https://github.com/DependencyTrack/dependency-track/discussions
|
||||
|
||||
Groups.io (mailing list)
|
||||
- https://dependencytrack.org/discussion
|
||||
|
||||
Providing as much detail as possible, what is your question?
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Slack Channel
|
||||
url: https://dependencytrack.org/slack
|
||||
about: Our Slack channel is the best way to get in touch!
|
||||
- name: GitHub Discussions
|
||||
url: https://github.com/DependencyTrack/dependency-track/discussions
|
||||
about: A good place to ask questions, share ideas and more!
|
||||
30
.github/ISSUE_TEMPLATE/defect-report.md
vendored
30
.github/ISSUE_TEMPLATE/defect-report.md
vendored
|
|
@ -1,30 +0,0 @@
|
|||
---
|
||||
name: Defect Report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: 'in triage'
|
||||
assignees: ''
|
||||
---
|
||||
The defect may already be reported! Please search for the defect before creating one.
|
||||
|
||||
|
||||
### Current Behavior:
|
||||
|
||||
|
||||
### Steps to Reproduce:
|
||||
|
||||
|
||||
### Expected Behavior:
|
||||
|
||||
|
||||
### Environment:
|
||||
|
||||
- Dependency-Track Version:
|
||||
- Distribution: [ Docker | Executable WAR | Traditional WAR ]
|
||||
- BOM Format & Version:
|
||||
- Database Server: [ H2 | MSSQL | MySQL | PostgreSQL ]
|
||||
- Browser:
|
||||
|
||||
### Additional Details:
|
||||
|
||||
(e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
|
||||
132
.github/ISSUE_TEMPLATE/defect-report.yml
vendored
Normal file
132
.github/ISSUE_TEMPLATE/defect-report.yml
vendored
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
name: Defect Report
|
||||
description: File a defect report
|
||||
labels: [ "defect", "in triage" ]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for helping us in making Dependency-Track better!
|
||||
|
||||
**Is the defect you'd like to report only UI-related?**
|
||||
We have a dedicated repo for the frontend, please create an issue [there](https://github.com/DependencyTrack/frontend/issues/new/choose)!
|
||||
Unsure? That's fine, just report it here! The maintainers will migrate the issue if necessary.
|
||||
|
||||
**Please do not ask questions here!**
|
||||
If you're not sure whether what you're experiencing is in fact a defect,
|
||||
you can reach out to maintainers and the broader community via various channels.
|
||||
Refer to our [contributing guidelines](https://github.com/DependencyTrack/dependency-track/blob/master/CONTRIBUTING.md#asking-questions) to find out where and how to ask questions.
|
||||
- type: textarea
|
||||
id: behavior-current
|
||||
attributes:
|
||||
label: Current Behavior
|
||||
description: |-
|
||||
Describe the current faulty behavior that you observed.
|
||||
Consider providing screenshots, log output, and other supplementary data.
|
||||
|
||||
*Files and images can be included via drag and drop into this text field.*
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: steps-to-reproduce
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: |-
|
||||
Describe the exact steps of how the defect can be reproduced.
|
||||
Consider providing screenshots, BOM files, and other supplementary data.
|
||||
|
||||
*Files and images can be included via drag and drop into this text field.
|
||||
For BOM files, please redact any internal or otherwise confidential information.*
|
||||
value: |-
|
||||
1.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: behavior-expected
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: >-
|
||||
Describe how you expect Dependency-Track to behave instead.
|
||||
validations:
|
||||
required: true
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Environment
|
||||
Please provide some details about the environment in which you observed the defect.
|
||||
- type: dropdown
|
||||
id: environment-dtrack-version
|
||||
attributes:
|
||||
label: Dependency-Track Version
|
||||
description: >-
|
||||
What version of Dependency-Track are you using?
|
||||
options:
|
||||
- 4.5.x
|
||||
- 4.6.0
|
||||
- 4.6.1
|
||||
- 4.6.2
|
||||
- 4.7.0-SNAPSHOT
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: environment-dtrack-distribution
|
||||
attributes:
|
||||
label: Dependency-Track Distribution
|
||||
description: >-
|
||||
Which [distribution](https://docs.dependencytrack.org/getting-started/distributions/) of Dependency-Track are you using?
|
||||
options:
|
||||
- Container Image
|
||||
- Executable WAR
|
||||
multiple: true
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: environment-database-server
|
||||
attributes:
|
||||
label: Database Server
|
||||
description: >-
|
||||
What database server are you using?
|
||||
options:
|
||||
- PostgreSQL
|
||||
- Microsoft SQL Server
|
||||
- MySQL
|
||||
- H2
|
||||
- N/A
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: environment-database-version
|
||||
attributes:
|
||||
label: Database Server Version
|
||||
description: |-
|
||||
What version of the database server are you using?
|
||||
|
||||
*If you selected H2 or N/A in the field above, you can leave this empty.*
|
||||
placeholder: "13.5"
|
||||
validations:
|
||||
required: false
|
||||
- type: dropdown
|
||||
id: environment-browser
|
||||
attributes:
|
||||
label: Browser
|
||||
description: |-
|
||||
What browser are you using?
|
||||
|
||||
*If the defect is not UI-related, just select the N/A option.*
|
||||
options:
|
||||
- Google Chrome
|
||||
- Mozilla Firefox
|
||||
- Apple Safari
|
||||
- Microsoft Edge
|
||||
- Other
|
||||
- N/A
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
options:
|
||||
- label: I have read and understand the [contributing guidelines](https://github.com/DependencyTrack/dependency-track/blob/master/CONTRIBUTING.md#filing-issues)
|
||||
required: true
|
||||
- label: I have checked the [existing issues](https://github.com/DependencyTrack/dependency-track/issues) for whether this defect was already reported
|
||||
required: true
|
||||
13
.github/ISSUE_TEMPLATE/enhancement-request.md
vendored
13
.github/ISSUE_TEMPLATE/enhancement-request.md
vendored
|
|
@ -1,13 +0,0 @@
|
|||
---
|
||||
name: Enhancement Request
|
||||
about: Request improvements or ideas for new features
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
The enhancement may already be reported! Please search for the enhancement before creating one.
|
||||
|
||||
### Current Behavior:
|
||||
|
||||
|
||||
### Proposed Behavior:
|
||||
46
.github/ISSUE_TEMPLATE/enhancement-request.yml
vendored
Normal file
46
.github/ISSUE_TEMPLATE/enhancement-request.yml
vendored
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
name: Enhancement Request
|
||||
description: File an enhancement request
|
||||
labels: [ "enhancement" ]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for helping us in making Dependency-Track better!
|
||||
|
||||
**Is the enhancement you'd like to request only UI-related?**
|
||||
We have a dedicated repo for the frontend, please create an issue [there](https://github.com/DependencyTrack/frontend/issues/new/choose)!
|
||||
Unsure? That's fine, just report it here! The maintainers will migrate the issue if necessary.
|
||||
|
||||
**Please do not ask questions here!**
|
||||
If you'd like to bounce ideas off or wonder whether what you want makes sense,
|
||||
you can reach out to maintainers and the broader community via various channels.
|
||||
Refer to our [contributing guidelines](https://github.com/DependencyTrack/dependency-track/blob/master/CONTRIBUTING.md#asking-questions) to find out where and how to ask questions.
|
||||
- type: textarea
|
||||
id: behavior-current
|
||||
attributes:
|
||||
label: Current Behavior
|
||||
description: |-
|
||||
Describe the current behavior that you observed.
|
||||
Consider providing screenshots, log output, and other supplementary data.
|
||||
|
||||
*Files and images can be included via drag and drop into this text field.*
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: behavior-proposed
|
||||
attributes:
|
||||
label: Proposed Behavior
|
||||
description: >-
|
||||
Describe how you expect Dependency-Track to behave instead.
|
||||
Please include *why* you want the new behavior.
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
options:
|
||||
- label: I have read and understand the [contributing guidelines](https://github.com/DependencyTrack/dependency-track/blob/master/CONTRIBUTING.md#filing-issues)
|
||||
required: true
|
||||
- label: I have checked the [existing issues](https://github.com/DependencyTrack/dependency-track/issues) for whether this enhancement was already requested
|
||||
required: true
|
||||
39
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
39
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
### Description
|
||||
|
||||
<!-- REQUIRED
|
||||
Provide a concise description of your change. What does it do? Why is it necessary?
|
||||
As a guideline, think about how you would describe your change if you were to write a changelog entry for it.
|
||||
-->
|
||||
|
||||
### Addressed Issue
|
||||
|
||||
<!-- REQUIRED
|
||||
Reference the issue addressed by this PR, e.g. `#1234`.
|
||||
Use keywords like `closes` or `fixes` to signal that this PR resolves the issue,
|
||||
causing the issue to be closed automatically when the PR is merged:
|
||||
https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
|
||||
-->
|
||||
|
||||
### Additional Details
|
||||
|
||||
<!-- OPTIONAL
|
||||
If desired, share more technical details about the change here.
|
||||
Elaborating on why you implemented the change the way you did can be super helpful to the reviewer.
|
||||
Did you consider other solutions? Any problems you ran into along the way?
|
||||
-->
|
||||
|
||||
### Checklist
|
||||
|
||||
<!-- REQUIRED
|
||||
Mark items in this list as done by adding a `x` between the square brackets.
|
||||
Non-applicable items may be marked as such by surrounding their text with tildes (`~`).
|
||||
|
||||
This is not meant to be a strict to-do list. If you're unsure about anything,
|
||||
just leave it empty for now. The maintainers are happy to assist you in figuring it out!
|
||||
-->
|
||||
|
||||
- [ ] I have read and understand the [contributing guidelines](https://github.com/DependencyTrack/dependency-track/blob/github-templates/CONTRIBUTING.md#pull-requests)
|
||||
- [ ] This PR fixes a defect, and I have provided tests to verify that the fix is effective
|
||||
- [ ] This PR implements an enhancement, and I have provided tests to verify that it works as intended
|
||||
- [ ] This PR introduces changes to the database model, and I have added corresponding [update logic](https://github.com/DependencyTrack/dependency-track/tree/master/src/main/java/org/dependencytrack/upgrade)
|
||||
- [ ] This PR introduces new or alters existing behavior, and I have updated the [documentation](https://github.com/DependencyTrack/dependency-track/tree/master/docs/_docs) accordingly
|
||||
|
|
@ -39,16 +39,6 @@ File a single issue per defect. Do not list multiple defects in the same issue.
|
|||
|
||||
The more information you can provide, the more likely we will be successful at reproducing the bug and finding a fix.
|
||||
|
||||
Please include the following with each bug report:
|
||||
|
||||
* The Dependency-Track version you are using (for both API server and frontend)
|
||||
* The Dependency-Track [distribution](https://github.com/DependencyTrack/dependency-track#distributions) you are using
|
||||
* The database you are using
|
||||
* Your operating system and version
|
||||
* What you expected, versus what happened
|
||||
* Reproducible steps (1 2 3...) that cause the defect including any required files
|
||||
* Any relevant screenshots and other outputs
|
||||
|
||||
API server logs (including errors) are logged to the following locations per default:
|
||||
|
||||
* `~/.dependency-track/dependency-track.log` (`/data/.dependency-track/dependency-track.log` within Docker containers)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue