Skip to content

Update the check_figures_equal testing section in CONTRIBUTING.md #1108

Merged
seisman merged 4 commits intomasterfrom
check-figures-equal-contributing
Mar 23, 2021
Merged

Update the check_figures_equal testing section in CONTRIBUTING.md #1108
seisman merged 4 commits intomasterfrom
check-figures-equal-contributing

Conversation

@willschlitzer
Copy link
Contributor

This PR moves the check_figures_equal notes from the top of the testing section to below the mpl_image_compare and dvc sections. It removes the note saying that check_figures_equal is the preferred method of testing as it avoids committing images to the repository. It adds that using mpl_image_compare is the preferred way of testing.

Fixes #

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@willschlitzer willschlitzer added the documentation Improvements or additions to documentation label Mar 23, 2021
@willschlitzer willschlitzer added this to the 0.4.0 milestone Mar 23, 2021
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Thanks @willschlitzer! Just one minor suggestion.

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

I'm fine with the changes, but let's leave it up for another 24 hours in case someone has an opinion on something.

@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label Mar 23, 2021
Co-authored-by: Meghan Jones <meghanj@hawaii.edu>
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

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

Nice!

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 23, 2021
@seisman seisman merged commit c064d4a into master Mar 23, 2021
@seisman seisman deleted the check-figures-equal-contributing branch March 23, 2021 19:38
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…nericMappingTools#1108)

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Co-authored-by: Meghan Jones <meghanj@hawaii.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants