Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Issue Template for new issue #155

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/0-bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: Report a Bug
description: Create a new ticket for a bug.
title: "Summarize the bug"
labels: [bug]

body:

- type: checkboxes
attributes:
label: "Checklist"
options:
- label: "I have searched for [similar issues](https://github.com/drprojects/superpoint_transformer/issues)."
required: true
- label: " I have tested with the lastest available version."
required: true
- label: "I have checked the [introduction page](https://github.com/drprojects/superpoint_transformer/blob/master/README.md ) and the [documentation](https://github.com/drprojects/superpoint_transformer/tree/master/docs) "
required: true
- label: " I have check that this bug is a SuperPoint Transformers bug and is not in fact a sub-dependency issue (ex: pytorch installation issue, pytorch geometric not installed with GPU support... )."

- type: textarea
attributes:
label: "Describe the issue"
description: >
Provide the *detailed* description of the issue you are facing. Include
references to any documentation or issues you referred.

validations:
required: true

- type: textarea
attributes:
label: "Steps to reproduce the bug"
description: >
Please provide step-by-step instructions and full source code to reproduce
the bug. The instructions shall be self-contained.
placeholder: |
<< your code here >>
import numpy as np


render: python
validations:
required: true

- type: textarea
attributes:
label: "Error message"
description: >
Please include the *full* error message, if any. You may submit/attach
the entire terminal output with the error message.
placeholder: |
<< Full error message >>
validations:
required: false

- type: textarea
attributes:
label: "Expected behavior"
description: >
A clear and concise description of what you expected to happen.

- type: textarea
attributes:
label: "Additional information"
description: >
Please add any additional information that could help us diagnose the
problem better. Provide screenshots if applicable. You may attach
log files, generated wheel, or any other files, that could be helpful.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/1-feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature Request
description: New feature request. Request to add some new functionality or improve the existing ones.
title: "Summarize your request."
labels: [feature request]

body:

- type: checkboxes
attributes:
label: "Checklist"
options:
- label: "I have searched for [similar issues](https://github.com/drprojects/superpoint_transformer/issues)."
required: true
- label: " I have tested with the lastest available version."
required: true
- label: "I have checked the [introduction page](https://github.com/drprojects/superpoint_transformer/blob/master/README.md ) and the [documentation](https://github.com/drprojects/superpoint_transformer/tree/master/docs) "
required: true

- type: textarea
attributes:
description: >
Describe what feature you'd like to have in SuperPoint Transformers.
label: "Proposed new feature or change"
validations:
required: true

- type: textarea
attributes:
label: "References"
description: Please share some references that can help us know more about this feature and try to implement the same. For ex. research paper, open-source codes, stackoverflow, etc.

- type: textarea
attributes:
label: "Additional information"
description: Add any other context or screenshots about the feature request here.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/2-question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@

name: Ask a Question
description: Ask a question on how to use SuperPoint Transformer, how to implement something, etc.
title: "Summarize the question. \")"
labels: [question]

body:

- type: checkboxes
attributes:
label: "Checklist"
options:
- label: "I have searched for [similar issues](https://github.com/drprojects/superpoint_transformer/issues)."
required: true
- label: " I have tested with the lastest available version."
required: true
- label: "I have checked the [introduction page](https://github.com/drprojects/superpoint_transformer/blob/master/README.md ) and the [documentation](https://github.com/drprojects/superpoint_transformer/tree/master/docs) "
required: true

- type: textarea
attributes:
label: "My Question"
description: >
Provide the *detailed* description of your query. Kindly attach code
snippets, screen-shots, data files used in your application, etc.
validations:
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true