cybercyst/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-05-05 15:43:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated How to ask for help (markdown)

Dave Cheney 2018-01-06 14:28:04 +11:00
parent 6b17f3bbc4
commit 9de7c03cbf
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
How-to-ask-for-help.md

@ -43,9 +43,8 @@ Further reading:
The best way to get help is to show The best way to get help is to show
1. **What you did what you did, ideally with a small complete, stand-alone, example.** 1. **What you did what you did, ideally with a small complete, stand-alone, example.**
If you ran a command, show the command that you ran. If your program failed, provide the source of the program that filed. If you ran a command, show the command that you ran. If your program failed, provide the source of the program that failed. If the program is too large, or you cannot share the source, instead provide a self contained, runnable example, that demonstrates the problem.
2. **What you expected to happen.** If you expected the command to complete successfully, say that.** 2. **What you expected to happen.** If you expected the command to complete successfully, say that. If you expected the program to produce a particular output, give an example of the output you expected.
If you expected the program to produce a particular output, give an example of the output you expected.
3. **What happened instead.** 3. **What happened instead.**
If the command failed, include the full output of the failure, not just a single line that you though was the cause. If the program failed to produce the expected output, include what it did output. If the command failed, include the full output of the failure, not just a single line that you though was the cause. If the program failed to produce the expected output, include what it did output.