This repository was archived by the owner on Mar 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 17.3k
This repository was archived by the owner on Mar 3, 2023. It is now read-only.
Migrate core package 'about' into Atom repo #17832
Copy link
Copy link
Closed
Labels
Description
This issue tracks the steps necessary to migrate the about package into the core atom/atom repository under the packages path:
Migration Checklist
NOTE: These steps should be taken in a clean branch off of master in your local clone of atom/atom. Only one package should be moved in a single pull request.
Phase 1 - Prepare repo for migration
- Merge or close existing pull requests on the
atom/aboutrepository
Some guidelines for merging vs closing PRs:
- Merge when the PR is small, useful, has no merge conflicts with
master, and has passing tests - Close when the changes are non-trivial, the PR has conflicts with
master, or there are failing tests in CI
If you close a PR, let the user know that we are currently moving the repository over to atom/atom so they should feel free to reopen the pull request there once the package code has been migrated.
Phase 2 - Migrate the package code
- Clone the
atom/aboutrepo into thepackagespath of your local Atom repository and then delete its.gitsubfolder - Edit Atom's
package.jsonfile to change theaboutentry inpackageDependenciesto reflect the local path of the package:"about": "file:./packages/about", - Run a full Atom build using
script/buildand verify that there are no unexpected build errors - Launch the Atom binary in the
./outfolder and spot check for any obvious issues - Open the Chrome Developer Tools console (Ctrl+Shift+I or Cmd+Option+I) and ensure that there are no errors written there. If there are, add them to this issue and investigate.
- Commit the migrated package code and any changes to Atom's
package-lock.jsonfiles to your branch using this commit message::arrow_right: Migrate core package 'about' into ./packages
Phase 3 - Make sure the package works and send a PR
- Run the full suite of Atom tests with
script/testand verify that they pass locally - If any tests fail, investigate and fix them then commit the fixes to your branch
- Create a PR against
atom/atomto verify that CI passes - Once CI is clean and the PR is approved, merge it
Phase 4 - Archive the about repo
- Move all existing issues from the
aboutrepo toatom/atomusing github-issue-mover or a script - Add a label titled
packages/aboutto the migrated issues so that they can be found easily - Update the original package repo's README.md to point contributors to the code's new home in
atom/atom. You can use the following text:### This package is now a part of the [core Atom repository](https://github.com/atom/atom/tree/master/packages/about), please direct all issues and pull requests there in the future!
- Archive the package repository by going to its Settings page, scroll down to the "Danger Zone" section and click "Archive this Repository"
Migration is now complete! 🎉
Reactions are currently unavailable