Skip to content

Commit 9c673f4

Browse files
authored
Update transfer repo instructions to be nodejs/.github-aware (#682)
1 parent cc7b718 commit 9c673f4

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

transfer-repo-into-the-org.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,23 @@
44

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

7-
- `CODE_OF_CONDUCT.md`: it can be a reference to
8-
[the Node.js Code of Conduct][coc].
9-
- `CONTRIBUTING.md`: if there isn't one already, [the contributing guide][]
10-
of Node.js core could be a good example. Consider including the Developer's
11-
Certificate of Origin section in the document to avoid potential copyright
12-
conflicts.
137
- `LICENSE`, or other kind of documents that describe the license of
148
the project.
159
- `README.md`
1610

11+
Ideally, it would not have the following documents to inherit them from
12+
[nodejs/.github](https://github.com/nodejs/.github):
13+
14+
- `CODE_OF_CONDUCT.md`.
15+
- `CONTRIBUTING.md`: if there is one already, consider including the Developer's
16+
Certificate of Origin section in the document to avoid potential copyright
17+
conflicts.
18+
19+
Note that if the above documents are not checked out on the repository, they
20+
will appear on the GitHub web UI but not on local clones of the repository. The
21+
upside is that if the upstream document updates, no action needs to be taken for
22+
the downstream repository to stay up-to-date.
23+
1724
It's recommended to set the default branch to `main` before transferring the
1825
repository to the org, assuming that's possible without breaking existing
1926
tooling or workflows.

0 commit comments

Comments
 (0)