Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 3.24 KB

transfer-repo-into-the-org.md

File metadata and controls

71 lines (52 loc) · 3.24 KB
Raw

Transferring an existing repository into the organization

Step 1. Get the repository ready

Ideally, the repository should have the following documents in place:

  • LICENSE, or other kind of documents that describe the license of the project.
  • README.md

Ideally, it would not have the following documents to inherit them from nodejs/.github:

  • CODE_OF_CONDUCT.md.
  • CONTRIBUTING.md: if there is one already, consider including the Developer's Certificate of Origin section in the document to avoid potential copyright conflicts.

Note that if the above documents are not checked out on the repository, they will appear on the GitHub web UI but not on local clones of the repository. The upside is that if the upstream document updates, no action needs to be taken for the downstream repository to stay up-to-date.

It's recommended to set the default branch to main before transferring the repository to the org, assuming that's possible without breaking existing tooling or workflows.

Step 2. Open an issue in the admin repository

The people opening the issue should be a member of the Node.js organization, so they can ping the relevant GitHub teams to discuss about the request. If the person who wants to initiate the request is not a member, they could ask an existing member to open the issue, or request to join the organization.

Go to the issue tracker of the Node.js admin repository, open an issue to request moving the repository into the organization. The issue should include:

  • The owner and the name of the repository, and a link to it.
  • What the repository is for, why it should be transferred into the organization.
  • Mention of @nodejs/tsc so the Technical Steering Committee members can be notified about the request and weigh in.

See the Node.js GitHub Organization Management Policy on how the request is approved.

Step 3. Transfer the repository

When the request is approved, the owner of the repository can start transferring the repository into the Node.js GitHub organization. The person can be made a member of the Node.js GitHub organization so they have the necessary permissions to complete the transfer.

See GitHub's documentation on transferring repos on how to perform the necessary actions.

Step 4. Manage releases

If the transferred repository has one or more associated npm packages for releases, the Node.js foundation npm account should be added to the list of the npm collaborators of the packages. The account is managed by the Node.js Build Working Group and only serves as a safety net. The releases should still be done by the original releasers.

See NPM Management on more about the Node.js foundation npm account.