AlistGo/alist

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

Open

#1,393 opened on Jul 25, 2022

View on GitHub
 (3 comments) (14 reactions) (0 assignees)Go (7,947 forks)batch import
accepteddocumentationgood first issue

Repository metrics

Stars
 (49,469 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

通用的

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

问题报告

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

功能请求

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

Contributor guide

Research direction
Read and understand the guidelines for submitting issues to avoid duplicates and invalid reports.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95