Skip to content

Issue template: convert to form and add log instructions for deskop - #13633

Merged
Frenzie merged 7 commits into
koreader:masterfrom
Frenzie:bug
Apr 20, 2025
Merged

Issue template: convert to form and add log instructions for deskop#13633
Frenzie merged 7 commits into
koreader:masterfrom
Frenzie:bug

Conversation

@Frenzie

@Frenzie Frenzie commented Apr 19, 2025

Copy link
Copy Markdown
Member

Follow-up to #13632, also see #13619 (comment).


This change is Reviewable

@Frenzie Frenzie added this to the 2025.05 milestone Apr 19, 2025
@Frenzie
Frenzie requested a review from Copilot April 19, 2025 20:42
@Frenzie Frenzie changed the title Issue template: conver to form and add log instructions for deskop Issue template: convert to form and add log instructions for deskop Apr 19, 2025

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the bug report issue template by introducing a new form-based template while removing the old markdown-based template.

  • Introduces the new .yml template with structured fields including dropdowns, input, and textarea types.
  • Removes the old .md template to streamline issue reporting.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
.github/ISSUE_TEMPLATE/bug_report.yml Added a new structured bug report template form
.github/ISSUE_TEMPLATE/bug_report.md Removed the legacy markdown bug report template

@mergen3107

Copy link
Copy Markdown
Contributor

Shouldn't it be tee crash.log?
To make it consistent with all other crash.log files :D (just a thought)

@benoit-pierre

Copy link
Copy Markdown
Member

Do we really want tee -a? IINM, the restart loop is handled inside the script, so I'm not sure appending to the file is a good idea.

@shuvashish76

shuvashish76 commented Apr 19, 2025

Copy link
Copy Markdown

Not necessary for other linux packages. But AppImage is an exception as we can run multiple versions of it. I guess it helps to detect which version has crashes/issues? 🤷🏻 Personally I find it useful, instead of moving each new crash.log to a separate location each-time I run KOReader then compare by multiple files in text editor..

This reverts commit f5fe146.
Comment thread .github/ISSUE_TEMPLATE/bug_report.yml Outdated
* Pocketbook: `applications/koreader/`
* Android: Go to [Menu] → Help → Bug Report to save logs to a file
* Deb / Flatpak / AppImage: Run `koreader-20xx 2>&1 | tee log.txt` from the terminal
* Deb / Flatpak / AppImage: Run `koreader-20xx 2>&1 | tee crash.log` from the terminal (or `koreader-20xx.AppImage` for AppImage)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

In flatpak it is flatpak run rocks.koreader.KOReader 2>&1 | tee crash.log

@Frenzie
Frenzie merged commit 0e2a462 into koreader:master Apr 20, 2025
@Frenzie
Frenzie deleted the bug branch April 20, 2025 09:12
@Commodore64user

Commodore64user commented Apr 20, 2025

Copy link
Copy Markdown
Member

Do logs get automatically converted to code blocks? And what about spoilers?

edit: i’ll answer my own first question, render: shell so yeah

@Frenzie

Frenzie commented Apr 20, 2025

Copy link
Copy Markdown
Member Author

And what about spoilers?

The most obvious alternative is to get rid of the render: shell and prefill it with the old:

<details>
  <summary>crash.log</summary>

```
<Paste crash.log content here>
```
</details>

But maybe paste for small, upload crash.log for large is better anyway. We'll see. It's not set in stone, just an initial conversion.

Frenzie added a commit that referenced this pull request Apr 20, 2025
It wasn't in the old template, and I didn't think of it for #13633

See #13636
0xstillb pushed a commit to 0xstillb/koreader-thai that referenced this pull request May 9, 2026
0xstillb pushed a commit to 0xstillb/koreader-thai that referenced this pull request May 9, 2026
It wasn't in the old template, and I didn't think of it for koreader#13633

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants