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

【Thino】How to submit a good issue | 怎么提一个好的 Issue #518

Open
juestchaos opened this issue Apr 8, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@juestchaos
Copy link
Collaborator

juestchaos commented Apr 8, 2024

Feature Request | Requested Feature

  1. Before Submitting an Issue: Preferably, first search through both Closed and Open issues to see if your concern has already been addressed.
    • This approach can help reduce redundancy, offering a quicker resolution or better understanding of your issue.
    • Leveraging descriptions from others might help articulate your situation more accurately and clearly.
  2. While Submitting an Issue: Aim to describe a singular issue or phenomenon rather than compiling multiple issues together, as this facilitates easier tracking.
    • If you find someone has already raised a concern similar to yours, engaging through comments can help maintain the issue's visibility.
    • If you encounter an issue that mirrors yours, feel free to add your observations to provide more context.
  3. After Submitting an Issue: Regularly check back on the status of your issue, as developers typically use labels and responses to keep the communication clear and focused on resolving the issue.
    • Under view: Indicates that the authors and relevant parties are paying attention to the issue.
    • Discuss: Implies that achieving a solution requires discussion from both the authors and a broader user base, as product enhancements are not made from a single user's perspective.
    • Need more information: Means that more details are needed from the user to pinpoint the issue accurately.

The standardized format for submitting questions is beneficial for developers, testers, and other users to understand. You can refer to the following:

  • Add [Thino] in the title to describe issues with Thino's local plugins, e.g., [Thino] My Thino doesn't display the list.
  • Add [Thino Sync] in the title to describe Thino sync issues, WeChat sync.
  • Add [Thino Web] in the title to describe issues that occur in Thino web."

Feature Requested | 请求的功能

  1. 提 issue 前:可以优先在【已关闭】(close)和【未关闭】(open)的 issue 中查询是否有相似
    • 这样可以减少你的问题,让你快速解决,或者定位
    • 有了别人描述,可能你会描述的更准确清晰
  2. 提 issue 中:尽量描述单一问题和现象,不要多个问题写在一起,这样便于跟踪
    • 如果你发现别人提出和你一样的诉求,可以通过 comment 等方式让这个问题保持更高的热度
    • 如果你发现了别人提出和你一样的问题,可以补充你的现象
  3. 提 issue 后:定期关注 issue 变化,一般开发人员会用 标签和回复来保持沟通和让问题更明确
    • under view:说明有作者和相关人员关注了这个问题
    • discuss:从作者和更多用户角度,需要讨论才能实现,产品不是站在单个用户视角来改造的
    • need more information:需要用户提供更多信息来确定

提交问题的规范格式,有利于参与开发和测试、以及其他用户了解,可参考如下:

  • 在标题中增加 [Thino] 用于描述 Thino 本地插件问题,如: [Thino] 我的 Thino 不显示列表
  • 在标题中增加 [Thino Sync] 用于描述 Thino 同步问题、微信同步
  • 在标题中增加 [Thino Web] 用于描述 Thino web 中发生的问题
@juestchaos juestchaos added the documentation Improvements or additions to documentation label Apr 8, 2024
@juestchaos juestchaos pinned this issue Apr 8, 2024
Repository owner deleted a comment from Issues-translate-bot Apr 8, 2024
@Quorafind Quorafind changed the title 【Thino】issue 规范 【Thino】How to submit a good issue | 怎么提一个好的 Issue Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant