-
Notifications
You must be signed in to change notification settings - Fork 92
chore: add PR template #1045
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
Merged
+74
−0
Merged
chore: add PR template #1045
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f9f4b19
chore: add PR template
chaptersix 77ef3b5
chore: remove how did you test section from pr template
chaptersix e6292b5
chore: improve PR template based on review feedback
chaptersix 5ef43b7
Merge branch 'main' into chore/pr-template
chaptersix 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,74 @@ | ||
| ## Related issues | ||
|
|
||
| <!-- Closes #123 --> | ||
|
|
||
| ## What changed? | ||
|
|
||
| <!-- Describe what this PR does at a high level. --> | ||
|
|
||
| ## Checklist | ||
|
|
||
| <!-- Your PR should satisfy all these requirements. However, feel free to remove items that don't apply to the PR. Consider giving this checklist to an AI agent before opening your PR. --> | ||
|
|
||
| **Stability** | ||
| - [ ] Breaking changes are marked with 💥 in the PR title and release notes | ||
| - [ ] Changes to JSON output (`-o json` / `-o jsonl`) are treated as breaking changes | ||
|
|
||
| **Design** | ||
| - [ ] This feature does not depend on Cloud-only APIs or behavior (it works against an OSS server) | ||
| - [ ] New commands follow `temporal <noun> <verb>` structure (e.g. `temporal workflow start`) | ||
| - [ ] New flags are named after the API concept, not the implementation mechanism (good: `--search-attribute`, bad: `--index-field`) | ||
| - [ ] New flags don't duplicate an existing flag that serves the same purpose | ||
| - [ ] New flags do not have short aliases without strong justification | ||
| - [ ] Experimental features are marked with `(Experimental)` in `commands.yaml` | ||
|
|
||
| **Help text** (see style guide at the top of `commands.yaml`) | ||
| - [ ] All flags shown in help text and examples are implemented and functional | ||
| - [ ] Summaries use sentence case and have no trailing period | ||
| - [ ] Long descriptions end with a period and include at least one example invocation | ||
| - [ ] Examples use long flags (`--namespace`, not `-n`), one flag per line | ||
| - [ ] Placeholder values use `YourXxx` form (`YourWorkflowId`, `YourNamespace`) | ||
|
|
||
| **Behavior** | ||
| - [ ] Results go to stdout; errors and warnings go to stderr | ||
| - [ ] Error messages are lowercase with no trailing punctuation | ||
|
|
||
| **Tests** | ||
| - [ ] Added functional test(s) (`SharedServerSuite`) | ||
| - [ ] Added unit test(s) (`func TestXxx`) where applicable | ||
|
|
||
| ## Manual tests | ||
|
|
||
| <!-- Edit the code samples below to provide setup and happy-path and error-path testing instructions. --> | ||
|
|
||
| **Setup** | ||
| ``` | ||
| temporal server start-dev --headless | ||
| temporal workflow start \ | ||
| --type YourWorkflowType \ | ||
| --task-queue YourTaskQueue \ | ||
| --workflow-id YourWorkflowId | ||
| ``` | ||
|
|
||
| **Happy path** | ||
| ``` | ||
| $ temporal <command> \ | ||
| --flag value | ||
| <expected output> | ||
| ``` | ||
|
|
||
| **Error case** | ||
| ``` | ||
| $ temporal <command> \ | ||
| --invalid-combination | ||
| Error: <expected error message> | ||
| $ echo $? | ||
| 1 | ||
| ``` | ||
|
|
||
| **Composition** <!-- How might a user combine this with existing commands? e.g. using the output of one command as input to another --> | ||
| ``` | ||
| $ temporal <command-one> ... | ||
| $ temporal <command-two> --flag <value-from-above> | ||
| <expected output> | ||
| ``` | ||
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.
Uh oh!
There was an error while loading. Please reload this page.