-
Notifications
You must be signed in to change notification settings - Fork 101
docs: add new PR template to standardise contributions #125
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.
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
Open
liamchampton
wants to merge
1
commit into
main
Choose a base branch
from
docs/pr-template
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| <!-- | ||
| Thanks for contributing to gh-skyline! Please fill out the sections below | ||
| to help reviewers understand and validate your change. | ||
| --> | ||
|
|
||
| ## Description | ||
|
|
||
| <!-- A clear and concise description of what this PR does and why. --> | ||
|
|
||
| ## Related issues | ||
|
|
||
| <!-- Link any related issues, e.g. "Closes #123" or "Refs #456". --> | ||
|
|
||
| Closes # | ||
|
|
||
| ## Type of change | ||
|
|
||
| <!-- Check all that apply by replacing [ ] with [x]. --> | ||
|
|
||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Breaking change (fix or feature that would change existing behavior) | ||
| - [ ] Refactor / code cleanup (no functional change) | ||
| - [ ] Documentation update | ||
| - [ ] CI / build / tooling change | ||
| - [ ] Dependency update | ||
|
|
||
| ## Areas affected | ||
|
|
||
| <!-- Check all that apply. --> | ||
|
|
||
| - [ ] CLI commands / flags (`cmd/`) | ||
| - [ ] GitHub API client (`internal/github/`) | ||
| - [ ] STL generation / geometry (`internal/stl/`) | ||
| - [ ] ASCII art rendering (`internal/ascii/`) | ||
| - [ ] Logger / errors / utils (`internal/logger`, `internal/errors`, `internal/utils`) | ||
| - [ ] Types (`internal/types/`) | ||
| - [ ] Tests / fixtures / mocks (`internal/testutil/`) | ||
| - [ ] Documentation (README, CONTRIBUTING, etc.) | ||
| - [ ] CI workflows / linters (`.github/`) | ||
|
|
||
| ## How has this been tested? | ||
|
|
||
| <!-- | ||
| Describe the testing you performed. At minimum, run: | ||
|
|
||
| go test ./... | ||
| golangci-lint run | ||
|
|
||
| If your change affects STL output, please verify the file is valid | ||
| (e.g. opens correctly in a 3D viewer / slicer) and remains float32 | ||
| to comply with the binary STL format. | ||
| --> | ||
|
|
||
| - [ ] `go test ./...` passes locally | ||
| - [ ] `golangci-lint run` passes locally | ||
| - [ ] Manually ran the extension locally (e.g. `go run main.go --user <user> --year <year>` or `./rebuild.sh && gh skyline ...`) | ||
| - [ ] Verified the generated STL opens in a 3D viewer / slicer (if applicable) | ||
| - [ ] Added or updated unit tests for new / changed behavior | ||
|
|
||
| ### Commands run | ||
|
|
||
| ```bash | ||
| # Paste the commands you ran and a brief summary of the output | ||
| go test ./... | ||
| ``` | ||
|
|
||
| ## Screenshots / output | ||
|
|
||
| <!-- | ||
| If your change affects user-facing output, attach screenshots of: | ||
| - the ASCII art preview, and/or | ||
| - the rendered STL (3D viewer screenshot), and/or | ||
| - relevant terminal output. | ||
| --> | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] My code follows the style of this project (see [`.github/linters/.golangci.yml`](.github/linters/.golangci.yml)) | ||
| - [ ] I have added GoDoc comments for any new exported packages, functions, types, or constants | ||
| - [ ] Functions are focused and reasonably sized (generally under 50 lines) | ||
| - [ ] Final STL output uses `float32` to adhere to the STL format (if applicable) | ||
| - [ ] I have updated the README / docs where relevant (new flags, behavior changes, etc.) | ||
| - [ ] I have read the [Contributing guide](../CONTRIBUTING.md) and [Code of Conduct](../CODE_OF_CONDUCT.md) | ||
|
|
||
| ## Additional notes for reviewers | ||
|
|
||
| <!-- Anything else reviewers should know: trade-offs, follow-ups, open questions, etc. --> | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The checklist links use
../CONTRIBUTING.mdand../CODE_OF_CONDUCT.md. Since this template is inserted into the PR body (not rendered as a file in a directory),../links can resolve incorrectly on GitHub. Prefer repo-root relative links likeCONTRIBUTING.md/CODE_OF_CONDUCT.md(or/CONTRIBUTING.md//CODE_OF_CONDUCT.md) so they work reliably from PRs/issues.