Skip to content

Update the contributing guide about pushing changes to dvc and git#1776

Merged
seisman merged 5 commits intomainfrom
dvc-push
Mar 4, 2022
Merged

Update the contributing guide about pushing changes to dvc and git#1776
seisman merged 5 commits intomainfrom
dvc-push

Conversation

@seisman
Copy link
Member

@seisman seisman commented Mar 1, 2022

Description of proposed changes

  1. Run dvc status --remote upstream before dvc push
  2. Run dvc push before git push

Fixes #1765

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • 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

@seisman seisman added the documentation Improvements or additions to documentation label Mar 1, 2022
@seisman seisman added this to the 0.6.0 milestone Mar 1, 2022
@maxrjones
Copy link
Member

maxrjones commented Mar 3, 2022

Should we remove the following line since all the tests are now managed with dvc?

git rm -r --cached 'pygmt/tests/baseline/test_logo.png'  # only run if migrating existing image from git to dvc

maxrjones
maxrjones reviewed Mar 3, 2022
View reviewed changes
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.

I think some explanatory comments could be helpful.

@seisman
Apply suggestions from code review
7a2552a 
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
@seisman
Copy link
Member Author

seisman commented Mar 3, 2022

Should we remove the following line since all the tests are now managed with dvc?

git rm -r --cached 'pygmt/tests/baseline/test_logo.png'  # only run if migrating existing image from git to dvc

Done in e8a3ad6

weiji14
weiji14 approved these changes Mar 3, 2022
View reviewed changes
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.

Just one minor suggestion, otherwise looks good!

@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label Mar 3, 2022
@seisman @weiji14
Update doc/contributing.md
20109a6 
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman seisman merged commit fc76cd5 into main Mar 4, 2022
@seisman seisman deleted the dvc-push branch March 4, 2022 09:15
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 4, 2022
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@seisman @weiji14
Update the contributing guide about pushing changes to dvc and git (G…
fe0105b 
…enericMappingTools#1776)

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

Reviewers

@maxrjones maxrjones maxrjones left review comments

@michaelgrund michaelgrund michaelgrund approved these changes

@weiji14 weiji14 weiji14 approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

0.6.0

Development

Successfully merging this pull request may close these issues.

Run "dvc push" before running "git push"?

4 participants

@seisman @maxrjones @michaelgrund @weiji14