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

Determine GitHub LFS impact on contributor experience #12

Open
mairin opened this issue Feb 28, 2024 · 3 comments
Open

Determine GitHub LFS impact on contributor experience #12

mairin opened this issue Feb 28, 2024 · 3 comments
Labels
question Further information is requested

Comments

@mairin
Copy link
Member

mairin commented Feb 28, 2024

Related to: instructlab/instructlab#62 (comment)

Over time the documents inside the taxonomy repo might get quite large. Cloning a massive repository will be an impediment to first time contributors. So having all the documents download as part of the clone might not be a good idea.

There was a decision to require contributors submitting knowledge to submit the documents via git-lfs.

How does requiring LFS impact contributor experience both command line and GitHub UI? For both:

  • contributors using git clients
  • contributors using the GitHub UI
@mairin mairin transferred this issue from instructlab/instructlab Feb 28, 2024
@xukai92
Copy link
Member

xukai92 commented Feb 28, 2024

related issue: #8

@ckadner ckadner added the question Further information is requested label Mar 5, 2024
@bjhargrave
Copy link
Contributor

Git LFS storage on GitHub is a paid feature when you exceed 1 GiB of storage or 1 GiB a month of bandwidth. Interestingly, forks count against the parent's repository's quota for storage and bandwidth. Additional data packs costs $5 per month for 50 GiB for bandwidth and 50 GiB for storage.

To add files to LFS, users will need to use the git client and also install the LFS addon. LFS will need to be configured to understand the extensions to place in LFS. This list can be managed via a .gitattributes file in this repository.

Contributors will not need to install LFS to clone the repo, but they will not be able to see or add files of the extentions configured for LFS.

I think it makes sense to use LFS if we expect individual files to exceed 50 MiB in size. But it may not make sense to use LFS just to handle a large amount of total data in the repository.

@bjhargrave
Copy link
Contributor

@mairin Since we are not putting knowledge documents in the taxonomy repository, perhaps this issue can be closed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants