Refine support case issue template #336
Closed
Conversation
This file contains 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
cbeams
suggested changes
Feb 7, 2020
There was a problem hiding this comment.
Please see the specific review comments, but in general, please also:
- Review and adhere to the guidelines at https://github.com/bisq-network/bisq/blob/master/CONTRIBUTING.md#write-well-formed-commit-messages.
- Review GitHub's documentation on how to create issue templates and pay special attention to how to write the YAML front matter that drives the issue template chooser. Right now, this issue template doesn't even show up as an option when creating a new issue, because this metadata is not in place. You can follow suit with how @KanoczTomas put together the fee reimbursement issue template YAML front matter at https://github.com/bisq-network/support/blob/master/.github/ISSUE_TEMPLATE/reimbursement-template.md.
Note that the check that failed on this PR was not your fault. I've fixed the underlying cause, and when you push changes to this PR branch, you should see no further failures.
Thanks.
| @@ -1,17 +1,7 @@ | |||
| <if contains sensitive info please use the encryption feature on Keybase> | |||
There was a problem hiding this comment.
- Please use HTML comments, e.g.
- Please do not put this at the top of the file. For parsing reasons as discussed in Keybase chat.
Comment on lines
+2
to
+5
| user_request_block_height: | ||
| agent_response_block_height: | ||
| resolution_block_height: | ||
| support_type: <L1 / L2> |
There was a problem hiding this comment.
What I suggested in Keybase was the following:
user_request_date: 2020-02-06T18:35:52Z
agent_response_date: 2020-02-06T18:39:01Z
Lorem ipsum dolor sit amet (description text)
- You acknowledged that dropping block height makes sense, but it's still here. Please change it to what's seen above.
- I mentioned in chat that the resolution date can be dropped because we can infer it from the issue close date. Pleaes remove.
- I read your comment about keeping the support type field, but I really do not want to include it. It's a likely example of YAGNI (you ain't gonna need it). Support agents are extremely likely to fail to fill this out and/or fail to come back and change it when it gets escalated to L2. It's just busy work, and will end up being a broken window in the system, and we have no requirement for it for our very basic metrics we're trying to track. Please remove.
| github-issue: | ||
|
|
||
| support_type: | ||
| <Prose describing the case, and (if already known), its solution; otherwise the solution summary comes with the closing comment. This prose includes any references to related issues e.g. bisq-network\/bisq#1234> |
There was a problem hiding this comment.
Again, please use HTML comments. When doing so, there should be no need to escape the issue reference.
|
Also, @Bisq-knight:
|
28 tasks
|
Closing due to inactivity. |
Actually closing this now as I never did it before. Superseded now in any case by #561. |
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.
(edited by @cbeams: this PR is per discussion between @Bisq-knight and @cbeams in
bisq.supportsubteam chat)