Skip to content

fix: improve issue comment messages #256

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.

Sign up for GitHub

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

Merged
naveensingh merged 1 commit into from
Oct 8, 2026
Merged

fix: improve issue comment messages #256

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions scripts/policy.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const ISSUE_FIELD_GUIDANCE = {
'expected-behavior': ['Expected behavior', 'Describe what should happen and when.'],
'feature-description': ['Feature description', 'Describe the requested change clearly, including how the app should behave.'],
'steps-to-reproduce': ['Steps to reproduce', 'Describe step-by-step how to reproduce or observe the problem.'],
'why-is-the-feature-requested': ['Reason for the feature', 'Explain the problem or limitation this change would solve.']
'why-is-the-feature-requested': ['Why do you want this feature?', 'Describe the problem or limitation this feature would solve, or how it would help you.']
};

const ISSUE_RESULTS = [
Expand Down Expand Up @@ -440,11 +440,11 @@ function missingDetailsMessage(fields, issueFieldIds) {

seen.add(field.id);
const [label, prompt] = fieldGuidance;
guidance.push(`- **${label}** (${field.state}): ${prompt}`);
guidance.push(`- **${label}** ${prompt}`);
}

if (guidance.length === 0) return ISSUE_MESSAGES.request_missing_details;
return `Thanks for the report. A few fields need more detail before we can investigate:\n\nMissing or incomplete fields:\n\n${guidance.join('\n')}`;
return `Thanks for the report. Please edit your issue to add the following details:\n\n${guidance.join('\n')}`;
}

function requiredIssueFieldIds(issueForms) {
Expand Down