Skip to content
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.

Sign up for GitHub

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

Update work item template #2818

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
+19 −13
Open

Update work item template #2818

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0e794f2
Update work item template
cptartur Dec 20, 2024
80ee25d
Apply suggestions from code review
cptartur Jan 10, 2025
292c91e
Remove `e.g.`
cptartur Jan 10, 2025
d50e1f8
Fix invalid start of sentence
cptartur Jan 10, 2025
4a3dcea
Merge branch 'master' into update-issue-templates
cptartur Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions .github/ISSUE_TEMPLATE/work_item.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
name: Work item
description: Submit an actionable task
body:
- type: dropdown
id: tool-name
- type: textarea
id: current-state
attributes:
label: Which components does the task require to be changed? (think hard pls)
multiple: true
options:
- snforge
- sncast
- cairo-profiler
- other (describe below)
label: Current State
description: Describe the current state and outline the problem
placeholder: Currently, the `print_a` cheatcode prints `"a"` to stdout. This is problematic because user might want it to be printed on their actual printer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
placeholder: Currently, the `print_a` cheatcode prints `"a"` to stdout. This is problematic because user might want it to be printed on their actual printer.
placeholder: e.g. Currently, the `print_a` cheatcode prints `"a"` to stdout. This is problematic because user might want it to be printed on their actual printer.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder will be displayed as a semi-opaque text in the text box that will disappear once user starts typing. I don't thing e.g. is necessary in that case.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fine, so let's remove it from all placeholders for consistency

validations:
required: true

- type: textarea
id: description
- type: input
id: objective
attributes:
label: Description
description: Describe the issue here.
label: Objective
description: Briefly describe the correct state
placeholder: The `print_a` cheatcode should magically detect if user wants to print to stdout or a printer.
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Provide additional context on the desired state.
placeholder: If we can detect any printers in local network it might indicate that user wants to print to it.
validations:
required: false
Loading