Skip to content

Commit

Permalink
Create Uni-Mol repository issue template. (#299)
Browse files Browse the repository at this point in the history
* Create bug-report.yml

* Update bug-report.yml

* Update bug-report.yml

* Create feature-request.yml

* Create documentation.yml

* Create generic-issue.yml

* Update documentation.yml

* Update documentation.yml

* Update generic-issue.yml

* Update bug-report.yml

* Update bug-report.yml

* Update bug-report.yml

* Update documentation.yml

* Update bug-report.yml

* Update bug-report.yml

* Update feature-request.yml

* Update generic-issue.yml

* Update generic-issue.yml

* Update documentation.yml
  • Loading branch information
RussellHu41 authored Dec 11, 2024
1 parent c0365df commit 90ad6af
Show file tree
Hide file tree
Showing 4 changed files with 141 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Bug report
description: Create a bug report to help us eliminate issues and improve Uni-Mol.
title: "[BUG] _Replace With Suitable Title_"
labels: bug
assignees: []
body:
- type: textarea
attributes:
label: Describe the bug
description: |
A clear and concise description of what the bug is.
validations:
required: true

- type: input
id: version
attributes:
label: Uni-Mol Version
description: "The version of Uni-Mol you are using, e.g. Uni-Mol, Uni-Mol2, Uni-Mol Tools, etc."
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: |
A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
attributes:
label: To Reproduce
description: |
It is recommended to attach your data, cases here for the developers to reproduce the bug.
- type: textarea
attributes:
label: Environment
description: |
- OS: [e.g. Ubuntu 20.04]
- Dependencies: [e.g. PyTorch, SciPy, NumPy, ...]
- type: textarea
attributes:
label: Additional Context
description: |
Add any other context about the problem here.
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Docs
description: For users or developers to report issues related to software documentation, such as missing or incomplete documentation, or documentation that is difficult to understand.
labels: documentation
assignees: []
body:
- type: textarea
attributes:
label: Details
description: |
Please provide details about the documentation issue you are experiencing. Include any relevant information such as the specific section of the documentation, the information that is missing or unclear, and any suggestions for improvement.
validations:
required: true
- type: markdown
attributes:
value: >
Thank you for reporting this documentation issue. We will review and update the documentation as necessary. 📚
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature request
description: Suggest an idea for this project.
title: "[Feature Request] _Replace with Title_"
labels: enhancement
assignees: []
body:
- type: textarea
id: summary
attributes:
label: Summary
description: "Please provide a brief and concise description of the suggested feature or change"
placeholder:
value:
validations:
required: true
- type: textarea
id: details
attributes:
label: Detailed Description
description: "Please explain how you would like to see Uni-Mol enhanced, what feature(s) you are looking for, what specific problems this will solve. If possible, provide references to relevant background information like publications or web pages, and whether you are planning to implement the enhancement yourself or would like to participate in the implementation. If applicable add a reference to an existing bug report or issue that this will address."
placeholder:
value:
validations:
required: true
- type: textarea
id: further
attributes:
label: Further Information, Files, and Links
description: "Put any additional information here, attach relevant text or image files and URLs to external sites, e.g. relevant publications"
placeholder:
value:
validations:
required: false
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/generic-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Generic issue
description: For issues that do not fit any of the other categories.
title: _Replace With a Descriptive Title_
labels: wontfix
assignees: []
body:
- type: textarea
id: summary
attributes:
label: Summary
description: "Please provide a clear and concise description of what the question is."
placeholder:
value:
validations:
required: true
- type: input
id: version
attributes:
label: Uni-Mol Version
description: "The version of Uni-Mol you are using, e.g. Uni-Mol, Uni-Mol2, Uni-Mol Tools, etc."
validations:
required: true
- type: textarea
id: details
attributes:
label: Details
description: "Please explain the issue in detail here."
placeholder:
value:
validations:
required: true
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!

0 comments on commit 90ad6af

Please sign in to comment.