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

reports are too verbose #98

Closed
yegor256 opened this issue Apr 23, 2024 · 16 comments
Closed

reports are too verbose #98

yegor256 opened this issue Apr 23, 2024 · 16 comments
Assignees
Labels
bug Something isn't working

Comments

@yegor256
Copy link

Take a look at this one: objectionary/eo#3127 (comment)

Such a long report is absolutely useless. Nobody reads it and nobody pays attention. In order to be useful, it has to be short and suggest only one specific improvement to be made. The message should be short (less than 30 words, I believe).

Copy link

@yegor256 thanks for the report, here is a feedback:

Problems

  1. Bug report is too verbose.
  2. Lengthy reports aren't effective; suggest one specific improvement.

Suggestions

  • Dear [Assigned/Product team],
  • I understand the issue with report #3127, and I appreciate your efforts to address it. I'd like to suggest a way to improve the bug report formulation for future reference.
  • Instead of providing a lengthy report that is difficult for others to read and understand, consider narrowing down the issue to one specific improvement. This will make your report concise, easy to understand, and more likely to receive attention from the team.
  • For example: "The report could be more efficient if it focused on streamlining the login process by reducing the number of steps required."
  • This suggestion aims to enhance the quality and effectiveness of future bug reports by keeping them concise and focused on a single improvement.
  • Thank you for your attention to this matter. I hope this suggestion is helpful.
  • Best regards,

Please fix the bug report in order it to get resolved faster.
Analyzed with Phind/Phind-CodeLlama-34B-v2

@h1alexbel
Copy link
Contributor

@yegor256 thanks for reporting this problem. Agreed, our improvements suggestion system is not good as we want, our next step is to make one suggestion only.

@h1alexbel h1alexbel self-assigned this May 1, 2024
@h1alexbel h1alexbel added the bug Something isn't working label May 1, 2024
h1alexbel added a commit that referenced this issue May 2, 2024
@h1alexbel
Copy link
Contributor

@rultor release, tag is 0.3.3

@rultor
Copy link
Collaborator

rultor commented May 2, 2024

@rultor release, tag is 0.3.3

@h1alexbel OK, I will release it now. Please check the progress here

@rultor
Copy link
Collaborator

rultor commented May 2, 2024

@rultor release, tag is 0.3.3

@h1alexbel Done! FYI, the full log is here (took me 8min)

@h1alexbel
Copy link
Contributor

h1alexbel commented May 2, 2024

@yegor256 we released a new version. Now it should look like this:

image

@yegor256
Copy link
Author

yegor256 commented May 2, 2024

@h1alexbel I believe, the best format would be a strictly one-sentence message saying: "I would recommend ..."

@h1alexbel
Copy link
Contributor

@yegor256 you mean drop problems and post only one suggestion?

h1alexbel added a commit that referenced this issue May 2, 2024
@h1alexbel
Copy link
Contributor

@yegor256 how about this?

image

@h1alexbel
Copy link
Contributor

@rultor release, tag is 0.3.4

@rultor
Copy link
Collaborator

rultor commented May 6, 2024

@rultor release, tag is 0.3.4

@h1alexbel OK, I will release it now. Please check the progress here

@rultor
Copy link
Collaborator

rultor commented May 6, 2024

@rultor release, tag is 0.3.4

@h1alexbel Done! FYI, the full log is here (took me 8min)

h1alexbel added a commit that referenced this issue May 6, 2024
@h1alexbel
Copy link
Contributor

@rultor release, tag is 0.3.5

@rultor
Copy link
Collaborator

rultor commented May 6, 2024

@rultor release, tag is 0.3.5

@h1alexbel OK, I will release it now. Please check the progress here

@rultor
Copy link
Collaborator

rultor commented May 6, 2024

@rultor release, tag is 0.3.5

@h1alexbel Done! FYI, the full log is here (took me 7min)

@h1alexbel
Copy link
Contributor

@yegor256 now should be fixed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants