Conversation
bug_report.md and feature_request.md were stock GitHub boilerplate -- "a clear and concise description of what the bug is" -- while epic.yml and work_item.yml ask for a scope boundary, caveats and a definition of done. Two shapes in one ISSUE_TEMPLATE directory, and the two markdown ones set the weaker example. Both become issue forms, so the required fields are enforced at submit time rather than by review. They keep the house discipline without borrowing maintainer-only sections that a reporter cannot fill: - bug_report: reproduction and observed-vs-expected are pasted, not paraphrased. The scope-boundary slot becomes "What you have not checked" -- a reporter knows their unknowns, not the fix's boundary. - feature_request: scope boundary, alternatives considered, caveats, and an observable "what done would look like". Says up front that schema and public-API changes get designed before they get built, so proposals stop arriving with a field layout already chosen. CONTRIBUTING's "Writing a good issue" said "both templates" and now covers all four plus the PR template, with the rule that `gh issue create --body` bypasses the form silently.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Converts
bug_report.mdandfeature_request.mdinto issue forms that match the disciplineepic.ymlandwork_item.ymlalready ask for.Motivation and Context
ISSUE_TEMPLATE/held two shapes.epic.ymlandwork_item.ymlrequire a scope boundary, caveats and a definition of done.bug_report.mdandfeature_request.mdwere stock GitHub boilerplate — "A clear and concise description of what the bug is" — and being markdown templates, none of their fields were required.The weaker pair set the example for every repo in the org that inherits these templates, which is all of them.
How Has This Been Tested?
Both forms parse:
Not yet rendered in GitHub's form UI — that only happens once this is on
main. Worth a look at the chooser afterwards.Checked that nothing references the old filenames:
CONTRIBUTING.mdnames the templates by role, not by path.Breaking Changes
bug_report.mdandfeature_request.mdare deleted, so any link to those paths breaks. Nothing in this repo linked them. Links elsewhere in the org are unverified — I did not sweep the other repos.Existing issues are unaffected; templates apply at creation.
Types of changes
Checklist
Additional context
The forms keep the house discipline without borrowing maintainer-only sections a reporter cannot fill:
CONTRIBUTING.md's "Writing a good issue" said "both templates"; it now covers all four issue forms plus the PR template, and says plainly thatgh issue create --bodybypasses the form.Blank issues are still enabled — this PR does not change
config.yml.The matching skill-side change is codellm-devkit/cldk-devtools#
docs/issue-prose-budget, which stops the skills keeping a second copy of these forms.