Skip to content

Fix the decorative required: on Dependency and restore the Overview guidance in devops-security's and incubator's blank forms #187

Description

@ale210

Overview

We need to fix two defects in the two blank issue forms in devops-security and incubator, so that the Dependency field's required: true can actually block an empty submission and the house-style Overview convention is visible to whoever is writing the issue. This repo already has both right; those two are what is left of the gap that #173 closed here.

This is filed on devops as a single cross-repo ticket — two small PRs, one assignee — the same way #174 was handled, because the two changes have to land together to keep the forms identical.

Action Items

The forms in the two repos are byte-identical pairsdevops-security and incubator hold the same two files, character for character (verified 2026-08-26). Make the same edit in all four files and keep them identical; the two repos should still diff clean when you are done.

Files, same names in both repos, under .github/ISSUE_TEMPLATE/:
blank-issue-form-with-dependency.yml and blank-issue-form-with-no-dependency.yml.

1. Make the Dependency field's required: true real

In blank-issue-form-with-dependency.yml (line 11 when written, may drift — find it by the value: key under id: dependency) the field is prefilled:

value: '- [ ]'
  • Change that value: to placeholder: in hackforla/devops-security
  • Change that value: to placeholder: in hackforla/incubator

Why this matters rather than being cosmetic: value: writes the text into the textarea, so the field is never empty, so the required: true two lines below it can never fail. Anyone can submit the dependency form with a bare unchecked box and no blocker listed, and the rendered issue then opens with an empty checklist that reads as if it means something. placeholder: shows the same hint as grey prompt text without putting it in the submitted body, which is what makes the requirement bite. This repo's equivalent field already uses placeholder:, and #173 made exactly this change to this repo's Action Items and Resources fields.

2. Restore the house-style Overview guidance

Neither form tells the writer the CoP's Overview convention. It only ever appeared in blank-issue-template.md, which was deleted in hackforla/devops-security#162, so the convention is currently undocumented in the two templates people actually use. devops carries it as a placeholder: on the Overview field.

  • Add the same Overview placeholder: block to both forms in hackforla/devops-security
  • Add the same Overview placeholder: block to both forms in hackforla/incubator

Copy it verbatim from this repo's .github/ISSUE_TEMPLATE/blank-issue-form.yml rather than retyping it, so all three repos end up on one wording instead of three. It goes directly under the existing description: Clearly state the purpose of this issue in 2 sentences or less line (line 18 in the dependency form, line 10 in the no-dependency form — accurate when written; find it by the label: Overview above it). Use placeholder:, not value: — the point of item 1 applies here too.

3. Verify after the PRs merge

GitHub renders issue templates from the default branch only, so none of this is observable from a branch — you have to come back after merge.

Resources/Instructions

Deliberately out of scope. Resources/Instructions is also marked required: true in these forms, which manufactures "N/A" filler on issues that genuinely have no external resource. That is not fixed here because it applies identically to all three repos, and changing it in two of them would create a new divergence rather than close one. It stays an open convergence decision.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status
    Prioritized Backlog

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions