You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
After running the above, double-check the results of `git status` to check that the list of changed files matches expectation.
@@ -346,14 +346,34 @@ If you made these changes on a fork, you should open a pull request against the
346
346
347
347
- A pull request should **only** migrate a single package. Please do **not** open pull request which attempts to migrate multiple packages at the same time.
348
348
- Notice that every commit includes a `Ref:` link back to the RFC issue on the main project repository. This is useful for providing additional context regarding changes, especially those involving deprecations.
349
-
- Provided you have properly setup your local repository (see the [contributing][stdlib-contributing] and [development][stdlib-development] guides), linting will be performed after every commit, and, prior to pushing changes to a remote repository, affected unit tests, examples, and benchmarks should automatically run. Depending on how widely used the original package was throughout stdlib, these quality control steps may take considerable time, and it is possible that unrelated lint errors may be flagged. If possible, address any failures, restage the changes, and attempt to commit or push again.
349
+
- Provided you have properly setup your local repository (see the [contributing][stdlib-contributing] and [development][stdlib-development] guides), linting will be performed after every commit, and, prior to pushing changes to a remote repository, affected unit tests, examples, and benchmarks should automatically run. Depending on how widely used the original package was throughout stdlib, these quality control steps may take considerable time, and it is possible that unrelated lint errors may be flagged. If possible, address any failures, restage the changes, and attempt to commit or push again. Note that resolution of failures, may require amending previous commits.
350
350
- As mentioned above, be **very careful** when performing global find-and-replace. It can be easy to mistakenly update non-applicable paths, thus breaking packages and all downstream dependents. You've been warned.
351
351
352
352
* * *
353
353
354
354
## Checklist
355
355
356
-
356
+
The following is a checklist you can use when performing a package migration:
357
+
358
+
-[ ] Established a clean repository and created a migration branch based on the latest changes on the upstream `develop`.
359
+
-[ ] Copied the existing package to the desired location.
360
+
-[ ] Updated require paths in the new package.
361
+
-[ ] Updated include directories in the new package.
362
+
-[ ] Updated header guards in the new package.
363
+
-[ ] Compiled native code and ran unit tests for the new package.
364
+
-[ ] Committed the new package to the migration branch.
365
+
-[ ] Removed the export of the original package from its parent namespace (if applicable).
366
+
-[ ] Committed the changes to the parent namespace (if applicable).
367
+
-[ ] Updated `require` paths across the project to refer to the new package.
368
+
-[ ] Discarded any path changes to the original package.
369
+
-[ ] Discarded any path changes to the `@stdlib/error` namespace.
370
+
-[ ] Discarded any path changes to the `@stdlib/repl/**/data` database files.
371
+
-[ ] Committed path updates.
372
+
-[ ] Removed the original package.
373
+
-[ ] Committed removal of the original package.
374
+
-[ ] Resolved any encountered lint errors or test failures when committing and/or pushing changes.
375
+
-[ ] Opened a pull request which performs one and only one package migration.
376
+
-[ ] The pull request includes at most `4` commits.
0 commit comments