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

Add instructions for reporting upstream bugs to contributing.md #1610

Merged
merged 3 commits into from
Nov 10, 2021
Merged

Add instructions for reporting upstream bugs to contributing.md #1610

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4abbee8
Add instructions for reporting upstream bugs to contributing.md
Nov 5, 2021
0ae2150
Apply suggestions from code review
Nov 8, 2021
244c82f
Merge branch 'main' into reporting-upstream-bugs
Nov 9, 2021
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
21 changes: 21 additions & 0 deletions doc/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,27 @@ top of the GitHub repository and click *New Issue*.
* After submitting your bug report, try to answer any follow up questions about the bug
as best as you can.

#### Reporting upstream bugs

If you are aware that a bug is caused by an upstream GMT issue rather than a
PyGMT-specific issue, you can optionally take the following steps to help resolve
the problem:

* Add the line `pygmt.config(GMT_VERBOSE='d')` after your import statements, which
will report the equivalent GMT commands as one of the debug messages.
* Either append all messages from running your script to your GitHub issue, or
filter the messages to include only the GMT-equivalent commands using a command
such as:

python <test>.py 2>&1 | awk -F': ' '$2=="GMT_Call_Command string" {print "gmt", $3}'

where `<test>` is the name of your test script.
* If the bug is produced when passing an in-memory data object (e.g., a
pandas.DataFrame or xarray.DataArray) to a PyGMT function, try writing the
data to a file (e.g., a NetCDF or ASCII txt file) and passing the data file
to the PyGMT function instead. In the GitHub issue, please share the results
for both cases along with your code.

### Submitting a Feature Request

* Find the [*Issues*](https://github.com/GenericMappingTools/pygmt/issues) tab on the
Expand Down