feat(install): add instructions for git packages #1525
Conversation
This file contains hidden or 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
avivkeller
requested review from
leobalter,
monishcm and
wraithgar
as code owners
|
Can't wait 🤞 |
|
If we're gonna advertise this more heavily we'll want to link to or reiterate some of the many quirks of installing from source control. A good example recently is this issue where some folks didn't know that because git source control and not published assets there are scripts that always run. We don't really recommend using git urls, such as it is. It's only sometimes helpful in local development and never a good idea for a published module. Git urls are not idempotent, and the assumption of many of them is that they are source code that needs to be built. |
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 PR adds instructions to documentation regarding the installation of packages from git repositories.
References
Ref: nodejs/api-docs-tooling#236 (comment)