Skip to content

[doc] Add checklist about external plugins/patches, testing nightly and searching issues to bug report template#15072

Merged
Frenzie merged 6 commits into
koreader:masterfrom
Frenzie:nightly
Mar 5, 2026
Merged

[doc] Add checklist about external plugins/patches, testing nightly and searching issues to bug report template#15072
Frenzie merged 6 commits into
koreader:masterfrom
Frenzie:nightly

Conversation

@Frenzie

@Frenzie Frenzie commented Mar 4, 2026

Copy link
Copy Markdown
Member

@mergen3107 Does that look how you envision it?


This change is Reviewable

@Frenzie Frenzie added this to the 2026.02 milestone Mar 4, 2026
@poire-z

poire-z commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

Do/should we mention somewhere that "if you use external plugins or user-patches, try first to reproduce your issue with all of them disabled" or something ?

Comment thread .github/ISSUE_TEMPLATE/bug_report.yml Outdated
Comment on lines +69 to +88
- type: dropdown
id: regression
attributes:
label: Regression
description: Did this issue start happening after a recent update?
options:
- Yes
- No
- Not sure
validations:
required: true

- type: input
id: last-working-version
attributes:
label: Last working version
description: If this issue is a regression, please specify the last version of KOReader where the issue did not occur.
placeholder: e.g., 2026.03, 2025.10-164-gf12ff96ad_2026-03-03
validations:
required: false

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@poire-z @benoit-pierre Do you suppose this is helpful or just noise?

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.

It's helpful, yes.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Helpful, most won't care, but some will think about that and may give us some hints.

Some issue when I try to view the file:
Critical There is a problem with this template
body[6]: options must not include booleans. Please wrap values such as 'yes', and 'true' in quotes.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I was fixing that as you were typing it. :-)

@mergen3107

Copy link
Copy Markdown
Contributor

Yes, looks great! The more information user provides (especially with and without trying nightly) the better.

@Frenzie Frenzie changed the title [doc] Add suggestion about nightly to bug report template [doc] Add checklist about external plugins/patches, testing nightly and searching issues to bug report template Mar 5, 2026
@Frenzie Frenzie merged commit 9f10243 into koreader:master Mar 5, 2026
3 checks passed
@Frenzie Frenzie deleted the nightly branch March 5, 2026 07:47
@Commodore64user

Copy link
Copy Markdown
Member

one thing to note though, sometimes disabling patches/plugins might still lead to crashes, even if not our fault, in this example #15054 the damage had been done by a patch and it continued to affect the programme afterwards, so I guess what I am saying is: "constant vigilance"

@shuvashish76

Copy link
Copy Markdown

Tested on the latest nightly build

Every single bug report issue now going to linked with #11068 which looks spammy. Better to hyperlink with wiki?
Also request to make that checkbox not mandatory. Most users use Stable release and it's additional step to go through nightly testing. From general users prospective "better I'll wait for next release fix than messing with unstable version". https://www.youtube.com/watch?v=gBdN7yPlypI

@mergen3107

Copy link
Copy Markdown
Contributor

@shuvashish76

Well, we've been there before :D

  1. Any stable/nightly KOReader version can be as unstable/stable respectively
  2. Many times exactly those new features or bugs were already fixed in a recent nightly. Sometimes next stable is delayed, virtually making one of the latest nightlies most commonly used

@shuvashish76

shuvashish76 commented Mar 7, 2026

Copy link
Copy Markdown

Yes I understand, having the checkbox is fine. My request is don't force users to test the nightly version. Let them file bug report without marking that checkbox.
Currently most users will either mark that checkbox without really testing nightly just to file their bug report or they'll wait for someone else to report and hope for the fix in next future release. Or better bug report via "Blank Issue".

@mergen3107

Copy link
Copy Markdown
Contributor

Yeah, I think we should force them to also write the full version hash of the nightly they tried :D

Otherwise it is impossible to understand where they stand

@Frenzie

Frenzie commented Mar 7, 2026

Copy link
Copy Markdown
Member Author

Any stable/nightly KOReader version can be as unstable/stable respectively

In some sense, but stable is definitely tested more.

Anyway, I didn't realize it'd take any link as a reference. Drat.

Frenzie added a commit to Frenzie/koreader that referenced this pull request Mar 7, 2026
Frenzie added a commit that referenced this pull request Mar 7, 2026
0xstillb pushed a commit to 0xstillb/koreader-thai that referenced this pull request May 9, 2026
…nd searching issues to bug report template (koreader#15072)

Also add field asking for regression info.
0xstillb pushed a commit to 0xstillb/koreader-thai that referenced this pull request May 9, 2026
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.

6 participants