Contributing to Git Large File Storage
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
This project adheres to the Open Code of Conduct. By participating, you are expected to uphold this code.
Feature requests are welcome, but will have a much better chance of being accepted if they meet the first principles for the project. Git LFS is intended for end users, not Git experts. It should fit into the standard workflow as much as possible, and require little client configuration.
- Large objects are pushed to Git LFS servers during git push.
- Large objects are downloaded during git checkout.
- Git LFS servers are linked to Git remotes by default. Git hosts can support users without requiring them to set up anything extra. Users can access different Git LFS servers like they can with different Git remotes.
- Upload and download requests should use the same form of authentication built into Git: SSH through public keys, and HTTPS through Git credential helpers.
- Git LFS servers use a JSON API designed around progressive enhancement. Servers can simply host off cloud storage, or implement more efficient methods of transferring data.
The Git LFS project is managed completely through this open source project. The
milestones show the high level items that are prioritized for future work.
Suggestions for major features should be submitted as a pull request that adds a
markdown file to
docs/proposals discussing the feature. This gives the
community time to discuss it before a lot of code has been written.
The Git LFS teams mark issues and pull requests with the following labels:
bug- An issue describing a bug.
enhancement- An issue for a possible new feature.
review- A pull request ready to be reviewed.
release- A checklist issue showing items marked for an upcoming release.
In general, contributors should develop on branches based off of
master and pull requests should be to
Submitting a pull request
- Fork and clone the repository
- Configure and install the dependencies:
- Make sure the tests pass on your machine:
- Create a new branch based on
git checkout -b <my-branch-name> master
- Make your change, add tests, and make sure the tests still pass
- Push to your fork and submit a pull request from your branch to
- Pat yourself on the back and wait for your pull request to be reviewed
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow the style guide where possible.
- Write tests.
- Update documentation as necessary. Commands have man pages.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
Git LFS depends on having a working Go 1.11.0+ environment.
On RHEL etc. e.g. Red Hat Enterprise Linux Server release 7.2 (Maipo), you will neet the minimum packages installed to build Git LFS:
$ sudo yum install gcc $ sudo yum install perl-Digest-SHA
In order to run the RPM build
rpm/build_rpms.bsh you will also need to:
$ sudo yum install ruby-devel
(note on an AWS instance you may first need to
sudo yum-config-manager --enable rhui-REGION-rhel-server-optional)
Building Git LFS
The easiest way to download Git LFS for making changes is
$ git clone firstname.lastname@example.org:git-lfs/git-lfs.git $ cd git-lfs
From here, run
make to build Git LFS in the
./bin directory. Before
submitting changes, be sure to run the Go tests and the shell integration
$ make test # runs just the Go tests $ cd t && make test # runs the shell tests in ./test $ script/cibuild # runs everything, with verbose debug output
Updating 3rd party packages
make vendorto update the code in the
- Commit the change. Git LFS vendors the full source code in the repository.
- Submit a pull request.
If you are the current maintainer, see the release howto for how to perform a release.