CONTRIBUTING.md: 💅 #3325
Merged
CONTRIBUTING.md: 💅 #3325
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We use the Markdown trick that the same number over and over again produces a list of numbers incrementing starting at that base. This is good, since it reduces the diff later on should the list ordering change, grow new elements, etc. But it is not desirable to start the list at zero. Let's instead increment the list starting at 1, that way we get lists of the form (1), (2), (3), instead of (0), (1), (2).
We no longer use the GitHub issue label `core-team`, hence let's remove it to indicate it as such.
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]: dfc0f2f (Merge pull request #3298 from git-lfs/ttaylorr/go-1.11.1, 2018-10-08) [2]: 35fe301 (Merge pull request #3208 from git-lfs/ttaylorr/go-mod, 2018-08-29)
ShellSession gives us marginally better highlighting, comparing
$ foo
$ bar
with:
```ShellSession
$ foo
$ bar
```
So, where appropriate, let's convert the former into the later.
bk2204
approved these changes
Oct 17, 2018
| 0. Make your change, add tests, and make sure the tests still pass | ||
| 0. Push to your fork and [submit a pull request][pr] from your branch to `master` | ||
| 0. Pat yourself on the back and wait for your pull request to be reviewed | ||
| 1. [Fork][] and clone the repository |
There was a problem hiding this comment.
While I'm personally partial to zero-based indexing, I agree it's not intuitive to most people, and one-based numbering is in agreement with typical style guides, so I think this is a good way forward.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request compiles a few miscellaneous changes that I've been sitting on for the
CONTRIBUTING.mddocument, that I had mentioned (and was reminded of) in #3317 (review)./cc @git-lfs/core