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.

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 to clone to install Git LFS in the repository #1049

Conversation

zacharyburnett
Copy link
Collaborator

#1046 added large image files that went into Git LFS. In order to use LFS, the git hooks must be installed to the repository (git lfs install). This PR adds that step to the cloning instructions in the README.

Checklist

  • added entry in CHANGES.rst under the corresponding subsection
  • updated relevant tests
  • updated relevant documentation
  • updated relevant milestone(s)
  • added relevant label(s)
  • ran regression tests, post a link to the Jenkins job below. How to run regression tests on a PR

@zacharyburnett zacharyburnett self-assigned this Dec 15, 2023
@zacharyburnett zacharyburnett requested a review from a team as a code owner December 15, 2023 20:17
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 15, 2023
Copy link
Collaborator

@ddavis-stsci ddavis-stsci left a comment

Choose a reason for hiding this comment

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

I (and Nadia?) think we need to reevaluate why we need git-lsf. This is just for some small ~48K images so it seems to be overkill to me.

My error, the largest is 890K. I'm not sure we need the full resolution image for the documentation and a smaller one should be fine. We can also save space using a jpg file.

Copy link

codecov bot commented Dec 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.94%. Comparing base (1a458a0) to head (df5ea63).
Report is 478 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1049   +/-   ##
=======================================
  Coverage   70.94%   70.94%           
=======================================
  Files         105      105           
  Lines        6979     6979           
=======================================
  Hits         4951     4951           
  Misses       2028     2028           
Flag Coverage Δ *Carryforward flag
nightly 63.06% <ø> (ø) Carriedforward from 1a458a0

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zacharyburnett zacharyburnett deleted the docs/explain_git_lfs branch January 23, 2024 18:08
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 no-changelog-entry-needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants