Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
- Fork and clone the repository
- Configure and install the dependencies:
script/bootstrap - Make sure the tests pass on your machine:
script/test - Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests still pass
- Push to your fork and submit a pull request
- Pat your self 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.
- Update
Godeps. - Run
script/vendorto update the code in the.vendor/srcdirectory. - Commit the change. Git LFS vendors the full source code in the repository.
- Submit a pull request.
If you are the current maintainer:
- Create a new draft Release. List any changes with links to related PRs.
- Make sure your local dependencies are up to date:
script/bootstrap - Ensure that tests are green:
script/test - Bump the version in
lfs/lfs.go, like this. - Build for all platforms with
script/bootstrap -all(you need Go setup for cross compiling with Mac, Linux, FreeBSD, and Windows support). - Test the command locally. The compiled version will be in
bin/releases/{os}-{arch}/git-lfs-{version}/git-lfs - Get the draft Release ID from the GitHub API:
curl -in https://api.github.com/repos/github/git-lfs/releases - Run
script/release -id {id}to upload all of the compiled binaries to the release. - Publish the Release on GitHub.