Skip to content

Commit 6a05989

Browse files
authored
Merge pull request #3325 from git-lfs/ttaylorr/contributing-misc-tweaks
CONTRIBUTING.md: 💅
2 parents 4e37747 + 5f79dda commit 6a05989

File tree

1 file changed

+26
-27
lines changed

1 file changed

+26
-27
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ community time to discuss it before a lot of code has been written.
3838
The Git LFS teams mark issues and pull requests with the following labels:
3939

4040
* `bug` - An issue describing a bug.
41-
* `core-team` - An issue relating to the governance of the project.
4241
* `enhancement` - An issue for a possible new feature.
4342
* `review` - A pull request ready to be reviewed.
4443
* `release` - A checklist issue showing items marked for an upcoming release.
@@ -49,13 +48,13 @@ In general, contributors should develop on branches based off of `master` and pu
4948

5049
## Submitting a pull request
5150

52-
0. [Fork][] and clone the repository
53-
0. Configure and install the dependencies: `make`
54-
0. Make sure the tests pass on your machine: `make test`
55-
0. Create a new branch based on `master`: `git checkout -b <my-branch-name> master`
56-
0. Make your change, add tests, and make sure the tests still pass
57-
0. Push to your fork and [submit a pull request][pr] from your branch to `master`
58-
0. Pat yourself on the back and wait for your pull request to be reviewed
51+
1. [Fork][] and clone the repository
52+
1. Configure and install the dependencies: `make`
53+
1. Make sure the tests pass on your machine: `make test`
54+
1. Create a new branch based on `master`: `git checkout -b <my-branch-name> master`
55+
1. Make your change, add tests, and make sure the tests still pass
56+
1. Push to your fork and [submit a pull request][pr] from your branch to `master`
57+
1. Pat yourself on the back and wait for your pull request to be reviewed
5958

6059
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
6160

@@ -71,48 +70,48 @@ them as separate pull requests.
7170

7271
### Prerequisites
7372

74-
Git LFS depends on having a working Go 1.11.0+ environment, with your standard
75-
`$GOROOT` and `$GOPATH` environment variables set.
73+
Git LFS depends on having a working Go 1.11.0+ environment.
7674

7775
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:
7876

79-
```
77+
```ShellSession
8078
$ sudo yum install gcc
8179
$ sudo yum install perl-Digest-SHA
8280
```
8381

8482
In order to run the RPM build `rpm/build_rpms.bsh` you will also need to:
8583

86-
`$ sudo yum install ruby-devel`
84+
```ShellSession
85+
$ sudo yum install ruby-devel
86+
```
8787

8888
(note on an AWS instance you may first need to `sudo yum-config-manager --enable rhui-REGION-rhel-server-optional`)
8989

9090
### Building Git LFS
9191

92-
The easiest way to download Git LFS for making changes is `go get`:
93-
94-
$ go get github.com/git-lfs/git-lfs
92+
The easiest way to download Git LFS for making changes is `git clone`:
9593

96-
This clones the Git LFS repository to your `$GOPATH`. If you typically keep
97-
your projects in a specific directory, you can symlink it from `$GOPATH`:
98-
99-
$ cd ~/path/to/your/projects
100-
$ ln -s $GOPATH/src/github.com/git-lfs/git-lfs
94+
```ShellSession
95+
$ git clone [email protected]:git-lfs/git-lfs.git
96+
$ cd git-lfs
97+
```
10198

10299
From here, run `make` to build Git LFS in the `./bin` directory. Before
103100
submitting changes, be sure to run the Go tests and the shell integration
104101
tests:
105102

106-
$ make test # runs just the Go tests
107-
$ cd t && make test # runs the shell tests in ./test
108-
$ script/cibuild # runs everything, with verbose debug output
103+
```ShellSession
104+
$ make test # runs just the Go tests
105+
$ cd t && make test # runs the shell tests in ./test
106+
$ script/cibuild # runs everything, with verbose debug output
107+
```
109108

110109
## Updating 3rd party packages
111110

112-
0. Update `go.mod`.
113-
0. Run `make vendor` to update the code in the `vendor` directory.
114-
0. Commit the change. Git LFS vendors the full source code in the repository.
115-
0. Submit a pull request.
111+
1. Update `go.mod`.
112+
1. Run `make vendor` to update the code in the `vendor` directory.
113+
1. Commit the change. Git LFS vendors the full source code in the repository.
114+
1. Submit a pull request.
116115

117116
## Releasing
118117

0 commit comments

Comments
 (0)