Repository navigation
PR template: ask for code examples, and something reviewers can try - #75
Merged
Merged
Conversation
…ed or what it writes
Viewer preview of 4ae0077 · reports from brentvatne/euxy#163
The link stays the same on every push. Deploy run |
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.
What and why
The template asked for screenshots, but nothing showed a change to how Explore is used. A new section, Code examples, asks for that. It covers changes to:
config.yaml;The example shows the change in use as a reader would write it: the command, the file it reads, and what it prints or writes. When existing usage changes, it shows that usage before and after. If nothing about usage changes, the author writes "No change to usage".
A second new section, Try it, is optional but recommended: something a reviewer can open or run to see the change. It points at:
The Screenshots section is unchanged.
Screenshots
No visible change.
Code examples
The new section, as it appears in the template:
The Try it section:
Try it
Nothing to try: the change is the template itself, which shows up on the next pull request opened after it merges.
Testing
Markdown only: no code or tests change. I haven't opened a pull request from the new template to see it rendered.
🤖 Generated with Claude Code