Skip to content

Conversation

@Lamparter
Copy link
Contributor

Simple change, just added a remarks/comments section to the bug report template to make it match that of the feature/code quality issue templates. Might be useful if the user wants to add a remark such as what they think might be the problem, screenshots, etc. Also fixed a few minor issues in the YAML comments.

@yaira2
Copy link
Member

yaira2 commented Oct 27, 2024

We used to have a longer template, but came to the realization that it's best to keep the form as simple as possible. If applicable, comments can be added to the description section.

@yaira2
Copy link
Member

yaira2 commented Oct 29, 2024

@Lamparter looking at the template, we can further optimize it by removing the requirements section. In most cases, the requirements can be inferred from the description and the steps to reproduce sections.

@yaira2 yaira2 added the changes requested Changes are needed for this pull request label Oct 29, 2024
@0x5bfa
Copy link
Member

0x5bfa commented Oct 29, 2024

@yaira2 do you like this?

IMG_0590

@yaira2
Copy link
Member

yaira2 commented Oct 29, 2024

Do you mean the tips?

@Lamparter
Copy link
Contributor Author

Lamparter commented Oct 29, 2024

Do you mean the tips?

Yes, as in using a blockquote.
I think it's a good idea but ultimately it's up to you 🙂

@0x5bfa
Copy link
Member

0x5bfa commented Oct 29, 2024

Yep

@yaira2
Copy link
Member

yaira2 commented Oct 29, 2024

We can try it. So in summary, these are the requested changes:

  • Remove comments section
  • Remove requirements section
  • Add the tips as discussed above

@Lamparter
Copy link
Contributor Author

Lamparter commented Oct 29, 2024

It might also be worth it to add a little section asking the user if they've updated Files and see if their issue is fixed on the latest version, like how it used to be in FluentHub.

image

@yaira2
Copy link
Member

yaira2 commented Oct 29, 2024

Most users tend to be on the latest version, so I think we're okay without that.

@Lamparter Lamparter requested a review from 0x5bfa October 29, 2024 15:49
Copy link
Member

@0x5bfa 0x5bfa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to me.

@Lamparter
Copy link
Contributor Author

This PR should probably be renamed.

@Lamparter Lamparter requested a review from yaira2 October 30, 2024 07:59
@Lamparter Lamparter changed the title GitHub: Add comments section to bug report GitHub: Improved issue templates Nov 3, 2024
yaira2
yaira2 previously approved these changes Nov 3, 2024
@Lamparter Lamparter requested a review from yaira2 November 4, 2024 07:53
@Lamparter Lamparter requested a review from yaira2 November 4, 2024 15:56
@yaira2 yaira2 merged commit 566cc8c into files-community:main Nov 4, 2024
6 checks passed
@yaira2 yaira2 added ready to merge Pull requests that are approved and ready to merge and removed changes requested Changes are needed for this pull request labels Nov 4, 2024
@Lamparter Lamparter deleted the remarks branch November 4, 2024 16:16
required: false

# Note that the user should always upload the report rather than pasting it.
- type: markdown
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if it's because of the wording, but the tip seems to have made things worse.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I should rethink it.

Copy link
Member

@yaira2 yaira2 Nov 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it's the word pasting, should we try Please **upload** the log file by clicking "Attach files".?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's better probably, @0x5bfa what do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have preference

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be interesting to see if there's a bot that could automate this by detecting a log in text and wrapping it with a <details/> block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready to merge Pull requests that are approved and ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants