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

在提交新的issue之前你需要知道的 / What you need to know before submit new issue #1393

Open
xhofe opened this issue Jul 25, 2022 · 2 comments
Labels
accepted documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@xhofe
Copy link
Collaborator

xhofe commented Jul 25, 2022

通用的

  • 看文档是一种好习惯
  • 先去搜索是否有重复的issue/discussion,不要再提交相同的issue这只会被标记为duplicate并立即关闭
  • issue只适用于问题报告和功能请求,提问请到discussion,否则会被标记为invalid并立即关闭
  • 请正确提供版本信息,否则(比如最新版)会被标记为invalid并立即关闭
  • 不要给我发私人邮件
  • issue原子化,在一个issue中请只包含一个问题报告或功能请求,若有多个请拆成多个issue

问题报告

  • 你需要确定这是程序本身的问题而不是其他(比如网络相关的报错)
  • 确定这是一个可以被修复的bug 而不是由于某些限制无法被修复(比如说浏览器不支持h265)
  • 需要尽量提供详细的复现步骤而不是只有一句话来描述结果
  • 如果是网页上的问题,必须提供一个复现链接,否则不会被处理

功能请求

  • 在提交这个功能请求之前,你应该先做一些调查搜索,而不是只有轻飘飘的一句话(比如说支持xxx后面什么都没有)
  • 对于特别小众且违背程序本意的需求是不会被实现的
  • 调查这是一个可以被实现的需求(比如说支持xx格式的文件预览但是浏览器根本不支持)
  • 对于新的存储驱动请求最好提供api文档
  • 对于其他类型的请求,尽量提供你查询到的相关资料,如果有一个详尽的实现思路就更棒了
@xhofe xhofe added the documentation Improvements or additions to documentation label Jul 25, 2022
@xhofe
Copy link
Collaborator Author

xhofe commented Jul 25, 2022

Generic

  • It is a good habit to read the documentation
  • First search for duplicate issues/discussions, don't submit the same issue again, it will just be marked as duplicate and closed immediately
  • Issues are only applicable to problem reports and feature requests, please go to discussion, otherwise they will be marked as invalid and closed immediately
  • Please provide correct version info, otherwise (such as latest) it will be marked as invalid and closed immediately
  • Don't send me personal e-mails
  • Issue atomized, containing only one issue report or feature request in one issue, or splitting into multiple issues if there are more than one

Bug report

  • You need to make sure that this is a problem with the program itself and not something else (such as a network related error)
  • Make sure this is a bug that can be fixed and not unfixable due to some limitations (like browsers not supporting h265)
  • Try to provide detailed reproduction steps instead of just one sentence describing the results
  • If it is a problem on a webpage, a reproduction link must be provided, otherwise it will not be processed

Feature request

  • Before submitting this feature request, you should do some research and search, not just a fluffy sentence (such as support for xxx and nothing after it)
  • Requirements that are particularly niche and contrary to the original intent of the program will not be implemented
  • Investigate that this is a requirement that can be implemented (eg file preview in xx format is supported but browsers don't support it at all)
  • Best to provide api documentation for new storage driver requests
  • For other types of requests, try to provide the relevant information you inquired, it would be better if you have a detailed implementation idea

@xhofe xhofe closed this as completed Jul 25, 2022
@xhofe xhofe changed the title 在提交新的issue之前你需要知道的 / What you should know before submit new issue 在提交新的issue之前你需要知道的 / What you need to know before submit new issue Jul 25, 2022
@xhofe xhofe pinned this issue Jul 25, 2022
@xhofe xhofe added the good first issue Good for newcomers label Sep 19, 2022
@xhofe xhofe reopened this Mar 12, 2023
@stale
Copy link

stale bot commented Apr 25, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale No activity for more than 30 days label Apr 25, 2023
@xhofe xhofe added the accepted label Apr 25, 2023
@stale stale bot removed the stale No activity for more than 30 days label Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant