xdrs-core 0.20.0 → 0.20.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -36,7 +36,7 @@ Collectively, these are referred to as XDRs.
|
|
|
36
36
|
- ALWAYS use the following folder structure for XDR documents:
|
|
37
37
|
`.xdrs/[scope]/[type]/[subject]/[number]-[short-title].md`
|
|
38
38
|
- ALWAYS ignore symlinks paths. NEVER create or update documents inside symlinked folders.
|
|
39
|
-
- **Files listed in `.filedist` are external XDRs.** A file whose path appears in the workspace root `.filedist` file was distributed from an external source repository. It must NEVER be modified locally. To change it, submit the change to the source repository and re-extract the updated package. The `.filedist` format is one entry per line: `<relative-path>|<package>|<version>`. A scope is considered external when any of its files appear in `.filedist`, and tools (such as `xdrs-core lint`) will skip external scopes by default.
|
|
39
|
+
- **Files listed in `.filedist` are external XDRs.** A file whose path appears in the workspace root `.filedist` file was distributed from an external source repository. It must NEVER be modified locally. To change it, submit the change to the source repository and re-extract the updated package. The `.filedist` format is one entry per line: `<relative-path>|<package>|<version>`. A scope is considered external when any of its files appear in `.filedist`, and tools (such as `xdrs-core lint`) will skip external scopes by default. The `.filedist` file can also be used to detect which files changed when bumping an external scope to a newer version: compare the version field in `.filedist` entries before and after the upgrade and diff the affected paths to understand what decisions were added, updated, or removed.
|
|
40
40
|
- Optional supporting artifacts under the same subject:
|
|
41
41
|
- `.xdrs/[scope]/[type]/[subject]/researches/[number]-[short-title].md`
|
|
42
42
|
- `.xdrs/[scope]/[type]/[subject]/skills/[number]-[skill-name]/SKILL.md`
|
package/package.json
CHANGED