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

GitHub issue template improvement plan #6629

Closed
aaron-ai opened this issue Apr 21, 2023 · 5 comments · Fixed by #6645
Closed

GitHub issue template improvement plan #6629

aaron-ai opened this issue Apr 21, 2023 · 5 comments · Fixed by #6645

Comments

@aaron-ai
Copy link
Member

aaron-ai commented Apr 21, 2023

There are currently a few "issues" with the RocketMQ issue template, and I believe it is necessary to take a series of actions to improve it. Here are some of the problems:

  1. The issue template is overly lengthy, making it difficult for people to have the patience to read through. This leads to the issue template becoming merely a formality.
  2. We have already initiated an initiative urging users to ask questions in GitHub discussions. However, some issues still do not follow the corresponding guidelines. Can we somehow circumvent this in the issue template?
  3. It would be even better if multiple language versions could be provided, allowing non-native English-speaking developers to better understand our intentions of the issue specification(although I think the more universal English language is still worth encouraging).

These are some of my thoughts, and I welcome more people to join in.

@miles-ton
Copy link
Contributor

yeap, current issue template too bloated to see, we should make it cleaner. we should provide multiple issue templates for different kind of issue instead of trying use one template to describe all of them. three most common issue type may be bug, polish and new feature issue.

@RongtongJin
Copy link
Contributor

Good idea. The current template content is too redundant, and there are no other options besides Bug Reports and Features.

Regarding the third point, I suggest maintaining an English template to maintain consistency (if the template is in Chinese, would it cause more issues or pull requests to be written in Chinese? Alternatively, maybe we could writeother languages in Discussions as there are more questions, but try to keep issues and pull requests in English as much as possible).

@ShadowySpirits
Copy link
Member

Maintaining multiple issue templates is a good idea. In this way, we can add labels to different kinds of issues automatically, and then do some special work for these issues such as guiding users to ask questions in GitHub discussion.

@zhouxinyu
Copy link
Member

+1 to improve our issue template.

@drpmma
Copy link
Contributor

drpmma commented Apr 25, 2023

+1, and the pr template is also needed to update, see #5353

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants