Skip to content

Commit 0a7e54e

Browse files
committed
docs: update migration guide to minimize merge conflicts
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent 52a3af1 commit 0a7e54e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/contributing/moving_packages.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -285,20 +285,22 @@ A couple of very important notes to keep in mind when performing a global find-a
285285
- Be **very careful** to avoid erroneously updating the paths of packages whose names have a common prefix (e.g., `stats/base/dmaxabs`, `stats/base/dmaxsorted`, `stats/base/dmaxabssorted`). Those packages should **not** be inadvertently updated.
286286
- Additionally, ensure that, for packages having C implementations, if a package basename (e.g., `dmax`) has a hyphen, then downstream include paths also need to be updated. E.g., for package `stats/base/foo-bar` with include file `stats/base/foo_bar`, all downstream packages which include the previous header file need to be updated accordingly (e.g., `stats/strided/foo_bar`).
287287

288-
### 9. Avoid updating original package and error database
288+
### 9. Avoid updating original package and project databases
289289

290290
There are three packages where we do **not** want to update `require` paths.
291291

292292
- **The original package.** The original package should remain working and keep its original paths.
293293
- **The global error database.** The global error database is an append-only log. We need to avoid invalidating any existing references.
294294
- **The REPL databases.** Given the high velocity of stdlib development, updating these databases will create merge conflicts, which do not need to be immediately resolved. We can avoid the hassle of needing to rectify these conflicts by deferring to stdlib's daily cron job which automatically maintains and updates these databases.
295+
- **The namespace databases.** We avoid updating these databases for the same reasons as the REPL databases.
295296

296297
To dismiss any changes made to the above, run the following command
297298

298299
```bash
299300
git checkout -- ./lib/node_modules/@stdlib/path/to/original/package && \
300301
git checkout -- ./lib/node_modules/@stdlib/error && \
301302
git checkout -- ./lib/node_modules/@stdlib/repl/**/data && \
303+
git checkout -- ./lib/node_modules/@stdlib/namespace/**/data && \
302304
git status
303305
```
304306

@@ -308,6 +310,7 @@ For example,
308310
git checkout -- ./lib/node_modules/@stdlib/stats/base/dmax && \
309311
git checkout -- ./lib/node_modules/@stdlib/error && \
310312
git checkout -- ./lib/node_modules/@stdlib/repl/**/data && \
313+
git checkout -- ./lib/node_modules/@stdlib/namespace/**/data && \
311314
git status
312315
```
313316

0 commit comments

Comments
 (0)