docs: add GitHub issue templates and pull request template#22
Merged
Conversation
…documentation issues
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.
Summary
This PR adds a full suite of GitHub issue templates and a pull request template to
.github/. Six structured YAML issue templates cover every contribution type the project accepts. Aconfig.ymldisables blank issues and surfaces the private security reporting link. APULL_REQUEST_TEMPLATE.mdpre-fills the three-section PR description structure defined inCONTRIBUTING.md.Files Changed
Added:
.github/PULL_REQUEST_TEMPLATE.mdISSUE_TEMPLATE/bug-report.ymlconfig.ymldocumentation-issue.ymlfeature-request.ymlnew-platform-request.ymlnode-version-bump.ymltzdata-version-bump.ymlModified:
Deleted:
Key Changes
bug-report.yml— structured form for image misbehaviour reports. Requires the affected version tag, registry (Docker Hub or GHCR), platform (linux/amd64orlinux/arm64), description, steps to reproduce, actual behaviour, and expected behaviour. Includes a pre-flight note directing security vulnerabilities toSECURITY.mdrather than this form.config.yml— disables blank issue creation (blank_issues_enabled: false) and adds aReport a Security Vulnerabilitycontact link pointing directly to GitHub Private Vulnerability Reporting (/security/advisories/new), preventing security issues from being filed as public issues.documentation-issue.yml— structured form for documentation errors acrossREADME.md,CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md, or other files. Requires the affected file, issue type (typo, outdated version reference, incorrect content, broken link, incorrect code example, missing information, or other), the exact location, and the correct content.feature-request.yml— structured form for proposing new image capabilities. Requires a description, a justification explaining strict runtime necessity, and a distroless impact assessment confirming the addition does not introduce a shell, package manager, or OS utility. Optional fields for proposed implementation and additional context.new-platform-request.yml— structured form specifically for new build target platform or architecture requests (e.g.linux/arm/v7), distinct from a general feature request. Requires the exact Docker platform string, confirmation of an official Alpine Node.js image for that platform, confirmation of QEMU support in GitHub Actions, and a use case description.node-version-bump.yml— structured form for requesting a Node.js version upgrade. Requires the current and requested version and the exact Alpine image tag. Includes a note that version bumps always result in at minimum a major semver release.tzdata-version-bump.yml— structured form for requesting atzdataAlpine package upgrade. Requires the current pinned version, the requested version, and confirmation of availability in the Alpine 3.22 package repository.PULL_REQUEST_TEMPLATE.md— pre-fills the three required PR description sections (Summary, Files Changed, Key Changes) with inline HTML comments as author guidance, matching the structure defined inCONTRIBUTING.md.