docs: explain package source vs installed copies - #2599
Open
Aryan Singh K. (aryansk) wants to merge 1 commit into
Open
docs: explain package source vs installed copies#2599Aryan Singh K. (aryansk) wants to merge 1 commit into
Aryan Singh K. (aryansk) wants to merge 1 commit into
Conversation
Aryan Singh K. (aryansk)
requested review from
Daniel Meppiel (danielmeppiel) and
Sergio Sisternes (sergio-sisternes-epam)
as code owners
August 16, 2026 12:48
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds new documentation clarifying the distinction between an APM package’s canonical source repository and the installed (materialized) consumer copy, with recommended workflows for authors and consumers.
Changes:
- Documented “source vs installed” package concepts and best practices (don’t edit/commit installed copies).
- Added a step-by-step recommended author/consumer workflow with an example
git:dependency. - Clarified guidance for authoring and consuming within the same repository, including testing recommendations.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+52
to
+55
| APM does not currently provide a live-link/development-install mode that keeps | ||
| an installed consumer copy synchronized with edits in the source checkout. If | ||
| you need immediate feedback while authoring, test from the source repository or | ||
| re-run the install/update workflow after changes. |
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
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.
Closes #2183
Summary
Validation
main