Add instructions for reporting upstream bugs to contributing.md #1610
Conversation
doc/contributing.md
Outdated
| filter the messages to include only the GMT-equivalent commands using a command | ||
| such as: | ||
|
|
||
| python <test>.py 2>&1 | grep GMT_Call_Command | awk -F': ' '{print "gmt", $3}' |
There was a problem hiding this comment.
What about this command? It doesn't call grep.
| python <test>.py 2>&1 | grep GMT_Call_Command | awk -F': ' '{print "gmt", $3}' | |
| python <test>.py 2>&1 | awk -F': ' '$2=="GMT_Call_Command string" {print "gmt", $3}' |
There was a problem hiding this comment.
BTW, this command works for both Linux (GNU awk) and macOS (BSD awk).
There was a problem hiding this comment.
Do we want to have an equivalent command for Windows users? 🙂
There was a problem hiding this comment.
Does Windows provide any built-in tools to do tasks like awk?
There was a problem hiding this comment.
A quick search yields this https://superuser.com/questions/524822/awk-equivalent-functionality-on-windows/524836#524836, but not sure if it works with stderr/stdout from GMT.
There was a problem hiding this comment.
I don't really think we need to spend time on this, since it only applies to the subset of people who are voluntarily providing additional information about upstream bugs without WSL or Git for Windows installed. They can always post the full error message or we could extract the equivalent commands on a *nix system.
doc/contributing.md
Outdated
| filter the messages to include only the GMT-equivalent commands using a command | ||
| such as: | ||
|
|
||
| python <test>.py 2>&1 | grep GMT_Call_Command | awk -F': ' '{print "gmt", $3}' |
There was a problem hiding this comment.
Do we want to have an equivalent command for Windows users? 🙂
Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Wei Ji <[email protected]>
seisman
added
the
final review call
seisman
removed
the
final review call
…ricMappingTools#1610) Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Wei Ji <[email protected]>
Description of proposed changes
Add a section to the reporting a bug section of the contributing guide with steps to provide helpful information about upstream bugs.
Fixes #573
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version