Skip to content
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

Merged

Conversation

jbergstroem
Copy link
Member

  • Does make -j8 test (UNIX) or vcbuild test nosign (Windows) pass with
    this change (including linting)?
  • Is the commit message formatted according to [CONTRIBUTING.md][0]?
  • If this change fixes a bug (or a performance problem), is a regression
    test (or a benchmark) included?
  • Is a documentation update included (if this change modifies
    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

@rvagg
Copy link
Member

rvagg commented Mar 9, 2016

lgtm on this individual change.

We also have these in the top level:

.editorconfig
.eslintignore
.eslintrc
.gitattributes
.gitignore
.mailmap
android-configure
AUTHORS
BSDmakefile
CHANGELOG.md
CODE_OF_CONDUCT.md
COLLABORATOR_GUIDE.md
common.gypi
configure
CONTRIBUTING.md
GOVERNANCE.md
LICENSE
Makefile
node.gyp
README.md
ROADMAP.md
vcbuild.bat
WORKING_GROUPS.md

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?

@Trott
Copy link
Member

Trott commented Mar 9, 2016

CODE_OF_CONDUCT.md, COLLABORATOR_GUIDE.md, CONTRIBUTING.md, and GOVERNANCE.md are linked (with relative paths) in the README.md. I'd be inclined to keep them.

Removing GitHub templates from the tarball change: LGTM

@mscdex mscdex added the build Issues and PRs related to build files or the CI. label Mar 9, 2016
@jasnell
Copy link
Member

jasnell commented Mar 9, 2016

+1 to keeping CODE_OF_CONDUCT.md, COLLABORATOR_GUIDE.md, CONTRIBUTING.md and GOVERNANCE.md. The others I'm good with excluding.

@jbergstroem
Copy link
Member Author

@rvagg will open open a discussion that aims to target what a tarball (vs git clone) should contain.

@bnoordhuis
Copy link
Member

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.

@Trott
Copy link
Member

Trott commented Mar 9, 2016

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>
@jbergstroem jbergstroem force-pushed the fix/remove-github-templates-installer branch from 03940ba to 7f586c0 Compare March 9, 2016 23:28
@jbergstroem jbergstroem merged commit 7f586c0 into nodejs:master Mar 9, 2016
evanlucas pushed a commit that referenced this pull request Mar 14, 2016
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>
@evanlucas evanlucas mentioned this pull request Mar 14, 2016
rvagg pushed a commit that referenced this pull request Mar 16, 2016
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>
MylesBorins pushed a commit that referenced this pull request Mar 21, 2016
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>
MylesBorins pushed a commit that referenced this pull request Mar 21, 2016
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues and PRs related to build files or the CI.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants