Update CONTRIBUTING documentation with submodule instructions #1044
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
izgeri
reviewed
Dec 12, 2019
izgeri
reviewed
Dec 12, 2019
izgeri
reviewed
Dec 12, 2019
izgeri
reviewed
Dec 12, 2019
izgeri
reviewed
Dec 12, 2019
izgeri
suggested changes
Dec 12, 2019
BradleyBoutcher
force-pushed
the
mssql-submodule-documentation
branch
from
a41c3c0
to
920add8
Compare
Provides additional instructions and details for committing changes and using submodules
BradleyBoutcher
force-pushed
the
mssql-submodule-documentation
branch
from
920add8
to
399fca9
Compare
izgeri
reviewed
Dec 12, 2019
izgeri
approved these changes
Dec 12, 2019
There was a problem hiding this comment.
LGTM - thanks @BradleyBoutcher for writing up these detailed guidelines!!
diverdane
reviewed
Dec 12, 2019
| First, clone `https://github.com/cyberark/secretless-broker` with the `--recurse-submodules` flag. If you're new to Go, be aware that Go can be very selective | ||
| about where the files are placed on the filesystem. There is an environment variable called `GOPATH`, whose default value | ||
| First, clone `https://github.com/cyberark/secretless-broker` with the `--recurse | ||
| -submodules` flag. If you already have secretless-broker cloned locally, but are missing |
There was a problem hiding this comment.
The linebreak between --recurse and -submodules causes the rendered document to show --recurse -submodules (i.e. there's a space added.)
CONTRIBUTING.md
Outdated
|
|
||
| Secretless makes use of some third party libraries using Git Submodules. | ||
| Development on submodules is similar to just working with a second repository, in that | ||
| you can `cd` into it and check out branches or make seperate commits. However, you also |
There was a problem hiding this comment.
Nit - misspelling of separate here and down below (line 384)
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.
Provides additional instructions and details for committing changes
and using submodules