Skip to content

Add issue template for revdep check failures#7672

Open
Keykyrios wants to merge 2 commits intoRdatatable:masterfrom
Keykyrios:revdep-issue-template
Open

Add issue template for revdep check failures#7672
Keykyrios wants to merge 2 commits intoRdatatable:masterfrom
Keykyrios:revdep-issue-template

Conversation

@Keykyrios
Copy link

Fixes #7658.

Adds a YAML issue form template (.github/ISSUE_TEMPLATE/revdep_check_failure.yml)
for data.table maintainers to report revdep check failures that should be fixed
before the next CRAN release.

Based on the "Steps to report a new revdep check problem" section of the
Revdep checks wiki
(not the revdep issue template wiki, which is for issues in other repos).

The template includes:

  • pre-filing verification checklist (issue reproducibility, git bisect, etc.)
  • required fields: affected package, problem description, failing check output, first bad commit/PR link, R version(s) affected
  • optional fields: minimal reproducible example, additional context
  • auto-labels issues with revdep

Add a YAML issue form template (.github/ISSUE_TEMPLATE/revdep_check_failure.yml)
for data.table maintainers to report reverse dependency check failures
that should be fixed before the next CRAN release.

Based on the 'Steps to report a new revdep check problem' section of
https://github.com/Rdatatable/data.table/wiki/Revdep-checks

The template includes:
- pre-filing verification checklist (issue reproducibility, git bisect, etc.)
- required fields: affected package, problem description, failing check
  output, first bad commit/PR link, R version(s) affected
- optional fields: minimal reproducible example, additional context
- auto-labels issues with 'revdep'
Comment on lines +36 to +40
label: Affected package
description: Name of the revdep package that fails with data.table master.
placeholder: e.g. mlr3
validations:
required: true
Copy link
Member

Choose a reason for hiding this comment

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

link to package dev on github

Comment on lines +51 to +52
revdep shapr has new test failures due to warnings when
data.table master is installed.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
revdep shapr has new test failures due to warnings when
data.table master is installed.
revdep shapr has new test failures.

Comment on lines +81 to +91
- type: dropdown
id: r-version
attributes:
label: R version(s) affected
description: Which R version(s) show this failure?
options:
- Both R-devel and R-release
- R-devel only
- R-release only
validations:
required: true
Copy link
Member

Choose a reason for hiding this comment

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

delete

Comment on lines +12 to +31
- type: checkboxes
id: verification
attributes:
label: Pre-filing verification
description: |
Confirm the issue is real per the
[wiki guidelines](https://github.com/Rdatatable/data.table/wiki/Revdep-checks#steps-to-report-a-new-revdep-check-problem).
options:
- label: Found in more than one recent check (e.g. previous day)
required: false
- label: Occurs in both R-devel and R-release, or noted which one
required: false
- label: Result for data.table release matches result from CRAN
required: false
- label: "`git bisect` found a non-trivial first bad commit"
required: false
- label: Issue is in master (not only in release)
required: false
- label: Searched existing issues for this package and commit/PR
required: false
Copy link
Member

Choose a reason for hiding this comment

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

all these should be true before posting, please delete

value: |
Use this template to report a new revdep check failure found via
[revdep checks](https://github.com/Rdatatable/data.table/wiki/Revdep-checks).
Please verify the failure is real before filing; see checklist below.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Please verify the failure is real before filing; see checklist below.
Please verify the failure is real before filing; see checklist on that page.

@tdhock
Copy link
Member

tdhock commented Mar 17, 2026

also can you please enable issues on your fork so we can preview what this would look like?

@Keykyrios
Copy link
Author

@tdhock I have made your requested changes, as well as enabled the issues on my fork!

@tdhock
Copy link
Member

tdhock commented Mar 18, 2026

ok it looks like this Keykyrios#1
image

@tdhock
Copy link
Member

tdhock commented Mar 18, 2026

I think the problem description and MRE fields should be deleted, and change additional context prompt to indicate that MRE can be included there.
also can you please provide a template/example for the title? it should usually be something like
PACKAGE check TYPE fails after PR_DESCRIPTION

@tdhock
Copy link
Member

tdhock commented Mar 18, 2026

also can you please automatically assign the revdep label?
the test issue I created does not have any label
image

@tdhock
Copy link
Member

tdhock commented Mar 18, 2026

here are previous issues
image
lots start with "revdep" in the title but that is redundant with the revdep label, so I would suggest to not use revdep in future titles (but yes use the revdep label)

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 this pull request may close these issues.

issue template for revdep checks

2 participants