lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

CONTRIBUTING.md: no longer require GOROOT, GOPATH, etc

Browse Source 
Since the advent of [1], and [2], we use Go 1.11 with modules enabled.
This relieves us of the requirement of having Git LFS checked out within
the appropriate location beneath the caller's $GOPATH.

So, let's remove the guideline, and recommend away from using `go get`,
since this command behaves differently based on whether or not its CWD
is itself a Go repository.

Instead, recommend that we use `git clone`, and do not specify a
location to perform the clone in, since Git LFS can be checked out from
anywhere.

[1]: dfc0f2fc (Merge pull request #3298 from git-lfs/ttaylorr/go-1.11.1,
     2018-10-08)
[2]: 35fe301c (Merge pull request #3208 from git-lfs/ttaylorr/go-mod,
     2018-08-29)
This commit is contained in:
Taylor Blau 2018-10-17 10:54:26 -07:00
parent 6e94a68c1a
commit fedcef679d
1 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -70,8 +70,7 @@ them as separate pull requests.
### Prerequisites
Git LFS depends on having a working Go 1.11.0+ environment, with your standard
`$GOROOT` and `$GOPATH` environment variables set.
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:
@ -88,15 +87,10 @@ In order to run the RPM build `rpm/build_rpms.bsh` you will also need to:
### Building Git LFS
The easiest way to download Git LFS for making changes is `go get`:
The easiest way to download Git LFS for making changes is `git clone`:
$ go get github.com/git-lfs/git-lfs
This clones the Git LFS repository to your `$GOPATH`. If you typically keep
your projects in a specific directory, you can symlink it from `$GOPATH`:
$ cd ~/path/to/your/projects
$ ln -s $GOPATH/src/github.com/git-lfs/git-lfs
$ git clone git@github.com: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