仓库指标
- 星标
- (5,635 个星标)
- PR 合并指标
- (PR 指标待抓取)
描述
📌 提 Issue 前的“生存指南”
欢迎来到这里!为了保证沟通效率,不浪费彼此的生命,在按下 Submit new issue 按钮前,请务必花两分钟阅读以下黄金法则:
1. 🔍 拒绝做“伸手党”:先搜索,再提问
90% 的问题其实已经被人踩过坑了。在提问前,请务必先查阅文档、Q&A,并在已有的 Issues 和 Discussions 中善用搜索功能。请不要让开发者成为你的“人肉搜索引擎”。
2. 🎯 对号入座:选择正确的模板
请根据你的真实意图选择对应的表单,不要“挂羊头卖狗肉”:
- 🐛 Bug Report (错误报告):系统出现了明确的报错、崩溃或逻辑异常。请务必提供复现步骤,只有一句“用不了”的玄学问题我们无法施救。
- ✨ Feature Request (功能请求):你有能让项目变得更好的点子。注意:这必须是能造福大众的需求,而非你的“个人私享定制”。 提交时,请清晰描述该功能的应用场景、预期效果,如果能附带实现思路(路径)就更完美了。
- 🆘 Help Wanted & Others (求助与其他):如果你只是想问“怎么配置”、“为什么报错”,或者有其他闲聊话题,请左转前往 Discussions 讨论区。Issue 列表是用来追踪代码进度的“手术室”,不是用来答疑的“茶话会”。
3. 📝 填表定律:Garbage In, Garbage Out
表单里的必填项是底线,选填项是你的加分项。你提供的信息越详尽(环境、版本、日志等),开发者定位问题的速度就越快。如果关键信息严重缺失,你的 Issue 可能会被静默关闭。
4. 🤝 终极法则:保持体面与礼貌
开源项目是开发者在用爱发电,我们没有义务提供 7×24 小时的 VIP 客服。保持礼貌、心平气和地描述问题,是对彼此时间最大的尊重。
📌 Survival Guide Before Opening an Issue
Welcome! To ensure efficient communication and avoid wasting each other's time, please spend two minutes reading these golden rules before smashing that Submit new issue button:
1. 🔍 Don't be a "Help Vampire": Search before you ask
90% of the issues have probably already been encountered by someone else. Before asking, please consult the Docs, Q&A, and utilize the search function in existing Issues and Discussions. Please don't treat developers as your personal "human search engine."
2. 🎯 Take the Right Seat: Choose the correct template
Please select the form that matches your actual intent. Don't bait-and-switch:
- 🐛 Bug Report: The system has a clear error, crash, or logical anomaly. You MUST provide reproduction steps. We cannot magically fix an abstract "it doesn't work" complaint.
- ✨ Feature Request: You have a brilliant idea to make the project better. Note: This must be a feature that benefits the community, not your "personal custom requirement." When submitting, clearly describe the use case, expected outcome, and it's even better if you can attach an implementation idea or pathway.
- 🆘 Help Wanted & Others: If you just want to ask "how to configure," "why this error," or have casual chats, please turn left to the Discussions area. The Issue tracker is an "operating room" for tracking code progress, not a "tea party" for Q&A.
3. 📝 The Form Law: Garbage In, Garbage Out
The required fields in the template are the baseline; optional fields are your bonus points. The more detailed info you provide (environment, versions, logs, etc.), the faster developers can pinpoint the problem. If crucial information is severely lacking, your Issue might be silently closed without warning.
4. 🤝 The Ultimate Rule: Keep it Decent and Polite
Open-source projects run on developers' passion and free time. We have no obligation to provide 24/7 VIP customer service. Keeping it polite and describing your problem calmly is the greatest respect for each other's time.