-
Notifications
You must be signed in to change notification settings - Fork 29.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build: don't install github templates #5612
build: don't install github templates #5612
Conversation
lgtm on this individual change. We also have these in the top level: .editorconfig I wouldn't mind getting rid of .editorconfig, .gitattributes, .gitignore, .mailmap, CODE_OF_CONDUCT.md, COLLABORATOR_GUIDE.md, CONTRIBUTING.md, GOVERNANCE.md, ROADMAP.md, WORKING_GROUPS.md. I don't think they add anything valuable to a user downloading a source tarball. @nodejs/build @nodejs/ctc thoughts on why any of these should be kept in the source tarball? |
Removing GitHub templates from the tarball change: LGTM |
+1 to keeping CODE_OF_CONDUCT.md, COLLABORATOR_GUIDE.md, CONTRIBUTING.md and GOVERNANCE.md. The others I'm good with excluding. |
@rvagg will open open a discussion that aims to target what a tarball (vs git clone) should contain. |
Apropos the README, people that download the binaries frequently get confused about the build instructions in it. Perhaps it's better to distribute an abridged version in release tarballs, then we can drop the other *.md files too. |
I've certainly thought before that it might be good to either move all build instructions to a separate file or else minimize the instructions in the README and having detailed instructions in a separate file. I'm talking about in the repo, not just tarballs. |
Avoid putting github templates in the source tarballs. PR-URL: nodejs#5612 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Rich Trott <rtrott@gmail.com>
03940ba
to
7f586c0
Compare
Avoid putting github templates in the source tarballs. PR-URL: #5612 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Rich Trott <rtrott@gmail.com>
Avoid putting github templates in the source tarballs. PR-URL: #5612 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Rich Trott <rtrott@gmail.com>
Avoid putting github templates in the source tarballs. PR-URL: #5612 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Rich Trott <rtrott@gmail.com>
Avoid putting github templates in the source tarballs. PR-URL: #5612 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Rich Trott <rtrott@gmail.com>
make -j8 test
(UNIX) orvcbuild test nosign
(Windows) pass withthis change (including linting)?
test (or a benchmark) included?
existing APIs, or introduces new ones)?
Affected core subsystem(s)
build
Description of change
Avoid putting github templates in the source tarballs.
/cc @nodejs/build