Skip to content

DOC: Update the Contributing Guides after migration from DVC to Git LFS#4743

Open
seisman wants to merge 3 commits into
mainfrom
doc/dvc
Open

DOC: Update the Contributing Guides after migration from DVC to Git LFS#4743
seisman wants to merge 3 commits into
mainfrom
doc/dvc

Conversation

@seisman

@seisman seisman commented Jul 22, 2026

Copy link
Copy Markdown
Member

@seisman seisman added this to the 0.20.0 milestone Jul 22, 2026
@seisman seisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Jul 22, 2026

@michaelgrund michaelgrund left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good!

@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Jul 23, 2026
Comment thread doc/contributing.md Outdated
Comment thread doc/contributing.md Outdated
Comment on lines +686 to +687
GMT versions), they are managed with Git LFS rather than regular Git objects. Install
Git LFS and enable it once on your machine:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Would add a link to an installation guide to make clear that the command below does not install LFS.

Suggested change
GMT versions), they are managed with Git LFS rather than regular Git objects. Install
Git LFS and enable it once on your machine:
GMT versions), they are managed with Git LFS rather than regular Git objects. [Install
Git LFS](https://github.com/git-lfs/git-lfs?utm_source=gitlfs_site&utm_medium=installation_link&utm_campaign=gitlfs#installing) and then use the command below to enable it once on your machine:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

git-lfs is added to environment.yml (#4754) and will be available after setting up the environment, so I feel we can remove "Install Git LFS"

Comment thread doc/contributing.md
GMT versions), they are managed with Git LFS rather than regular Git objects. Install
Git LFS and enable it once on your machine:

git lfs install

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The command git lfs install actually installs Git LFS configuration, so the instruction is a little misleading.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done in beccd66.

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 final review call This PR requires final review and approval from a second reviewer skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants