Skip to content

Commit

Permalink
github: add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
zfb132 committed Apr 17, 2023
1 parent d068b95 commit b5a5622
Show file tree
Hide file tree
Showing 6 changed files with 128 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 命令标签分享
url: https://github.com/MuiseDestiny/zotero-gpt/discussions/3
about: 如果你制作了一个命令标签,欢迎在这里分享给大家
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/report_bug_cn.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: 插件问题反馈
description: "报告本插件存在的问题,且您确信这是插件问题而不是您的问题"
#title: ""
#labels: ["bug"]
body:
- type: markdown
attributes:
value: |
感谢提交反馈!请尽可能完整填写以下信息,帮助我们更好地定位问题和快速解决问题
**在一切开始之前,请确保您已经阅读过 [wiki](https://github.com/MuiseDestiny/zotero-gpt/wiki) 页面**
即使**重启**您的`Zotero`之后,该问题依然存在
------
- type: checkboxes
attributes:
label: 这个问题是否已有issue
description: 请搜索全部 issue 和 [wiki](https://github.com/MuiseDestiny/zotero-gpt/wiki) 以查看您想反馈的问题是否已存在或已解决
options:
- label: 我确认没有已有issue,且已阅读**常见问题**
required: true
- type: textarea
attributes:
label: 运行环境
description: |
请详细填写您的运行环境,以下是一个例子:
- **OS**: Windows11 22H2
- **Zotero version**: 6.0.23
- **Plugin version**: 0.2.3
value: |
- **OS**:
- **Zotero version**:
- **Plugin version**:
validations:
required: true
- type: textarea
attributes:
label: 当前配置信息
description: 如果能打开插件,请执行 `/report` 命令,将输出的信息**左键双击**复制粘贴到这里
placeholder: |
`api` https://api.openai.com
`secretKey` sk-...D6vr
`model` gpt-3.5-turbo
`temperature` 1.0
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: 问题详情
description: 请详细描述您遇到的问题。提示:如果可以,也请提供错误的截图
placeholder: |
描述您遇到的问题
说明您的预期结果和实际结果之间的差异
validations:
required: true
- type: textarea
attributes:
label: 补充说明
description: 链接?参考资料?任何更多背景信息!
placeholder: |
该问题是偶然发生的还是可以稳定复现?
是否与不同的Paper或PDF文件有关?
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/report_bug_en.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Plugin Issue Report
description: "Report issues with this plugin, and you believe that it is a plugin issue rather than your own issue"
body:
- type: markdown
attributes:
value: |
Thank you for submitting feedback! Please fill in the information below as completely as possible to help us better locate the issue and resolve it quickly.
**Before everything starts, make sure you have read the [wiki](https://github.com/MuiseDestiny/zotero-gpt/wiki) page**
Even after **restarting** your `Zotero`, the issue still persists
------
- type: checkboxes
attributes:
label: Has this issue been reported before?
description: Please search all issues and the [wiki](https://github.com/MuiseDestiny/zotero-gpt/wiki) to see if the issue you want to report already exists or has been resolved
options:
- label: I confirm that there is no existing issue, and I have read the **FAQ**
required: true
- type: textarea
attributes:
label: Operating Environment
description: |
Please provide detailed information about your environment, here is an example:
- **OS**: Windows11 22H2
- **Zotero version**: 6.0.23
- **Plugin version**: 0.2.3
value: |
- **OS**:
- **Zotero version**:
- **Plugin version**:
validations:
required: true
- type: textarea
attributes:
label: Current Configuration Information
description: If you can open the plugin, please run the `/report` command, and **double-click** to copy and paste the output here
placeholder: |
`api` https://api.openai.com
`secretKey` sk-...D6vr
`model` gpt-3.5-turbo
`temperature` 1.0
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: Issue Details
description: Please provide a detailed description of the issue you encountered. If possible, please also provide a screenshot of the error
placeholder: |
Describe the issue you encountered
Explain the difference between your expected results and the actual results
validations:
required: true
- type: textarea
attributes:
label: Additional Information
description: Links? References? Any more background information!
placeholder: |
Is the issue occurring randomly or can it be reproduced?
Is it related to different Papers or PDF files?
2 changes: 2 additions & 0 deletions .github/workflows/publish_wiki_tags.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ on:
push:
branches:
- bootstrap
paths:
- 'tags/*.txt'

jobs:
release:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Share the tag command you made in [here](https://github.com/MuiseDestiny/zotero-
Features about GPT:
- [x] 🔗 **Integrate with Zotero**: You can use the plugin to search and ask items in the library based on the selected text or the PDF file.
- [x] 🧠 Use GPT to generate reply text: support `gpt-3.5-turbo` and `gpt-4`
- [x] 🏷️ [Command tags](/README.md#command-tags): **Click once** to accelerate your research.
- [x] 🏷️ [Command tags](https://github.com/MuiseDestiny/zotero-gpt#command-tags): **Click once** to accelerate your research.
- [x] 💬 Ask questions about current **PDF file** (full-text or selected text).
- [x] 💬 Ask questions about **selected paper** (Abstract).
- [x] 📝 **Summarize the selected paper** into several highly condensed sentences.
Expand Down
File renamed without changes.

0 comments on commit b5a5622

Please sign in to comment.