Skip to content

docs: added a License - #36278

Merged
aduh95 merged 1 commit into
nodejs:masterfrom
iam-frankqiu:docs_license
Dec 15, 2020
Merged

docs: added a License#36278
aduh95 merged 1 commit into
nodejs:masterfrom
iam-frankqiu:docs_license

Conversation

@iam-frankqiu

@iam-frankqiuiam-frankqiu commented Nov 26, 2020

Copy link
Copy Markdown
Contributor

Added a License in README.md file.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 26, 2020
aduh95
aduh95 requested changes Nov 26, 2020
View reviewed changes

@aduh95aduh95 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our license file is https://github.com/nodejs/node/blob/master/LICENSE. I don't think there is any value to have that information in the README.

Trott
Trott reviewed Nov 28, 2020
View reviewed changes
Comment threadREADME.md Outdated
Trott
Trott requested changes Nov 29, 2020
View reviewed changes

@TrottTrott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"License" would need to be added to the table of contents around line 24 if we do it this way.

Can we maybe move this further down in the document? Maybe after "Contributing to Node.js" and before "Current Project Team Members"? Or maybe even all the way at the bottom of the document?

@Trott

Trott commented Nov 29, 2020

Copy link
Copy Markdown
Member

"License" would need to be added to the table of contents around line 24 if we do it this way.

Can we maybe move this further down in the document? Maybe after "Contributing to Node.js" and before "Current Project Team Members"? Or maybe even all the way at the bottom of the document?

By the way, if you prefer that I add a fixup commit to make these changes rather than implementing them yourself, let me know. I know it can be tedious when a small change like this gets a bunch of requests for changes.

@aduh95

aduh95 commented Nov 29, 2020

Copy link
Copy Markdown
Contributor

Can you move it above the definitions to fix the linter issue please?

@iam-frankqiu

iam-frankqiu commented Nov 30, 2020

Copy link
Copy Markdown
ContributorAuthor

Can you move it above the definitions to fix the linter issue please?

Sure.

@aduh95

aduh95 commented Nov 30, 2020

Copy link
Copy Markdown
Contributor

I think this is almost ready, there is just one point left:

"License" would need to be added to the table of contents around line 24 if we do it this way.

@iam-frankqiu

iam-frankqiu commented Nov 30, 2020

Copy link
Copy Markdown
ContributorAuthor

"License" would need to be added to the table of contents around line 24 if we do it this way

I think this is almost ready, there is just one point left:

"License" would need to be added to the table of contents around line 24 if we do it this way.

Ok. It's done finally. Thanks to @aduh95@Trott.

jasnell
jasnell reviewed Nov 30, 2020
View reviewed changes
Comment threadREADME.md Outdated

@jasnelljasnellNov 30, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should link to the LICENSE file instead.

@aduh95aduh95Nov 30, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The license file is linked just below, are you suggesting to also remove the See LICENSE for the full license text sentence?

@mhdawsonmhdawsonDec 9, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping @jasnell I think this is the last thing we need to clarify before this can land.

@jasnelljasnellDec 15, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, removing the last sentence and moving the link to the LICENSE file should work.

@aduh95aduh95Dec 15, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jasnell sorry I missed your comment before landing, do you want me to revert?

@Trott

Trott commented Dec 2, 2020

Copy link
Copy Markdown
Member

No need to fix it in the PR but here's a commit message nit-pick for whoever lands this: The first word after the subsystem should be an imperative mood verb. So add instead of added.

@iam-frankqiu

iam-frankqiu commented Dec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

No need to fix it in the PR but here's a commit message nit-pick for whoever lands this: The first word after the subsystem should be an imperative mood verb. So add instead of added.

Thank you. I will remember it.

@aduh95aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 3, 2020
mhdawson
mhdawson approved these changes Dec 9, 2020
View reviewed changes

@mhdawsonmhdawson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@iam-frankqiu@aduh95
doc: add license info to the README
91fe3de
PR-URL: nodejs#36278
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@aduh95

aduh95 commented Dec 15, 2020

Copy link
Copy Markdown
Contributor

Landed in 91fe3de

@aduh95
aduh95 merged commit 91fe3de into nodejs:masterDec 15, 2020
targos pushed a commit that referenced this pull request Dec 21, 2020
@iam-frankqiu@targos
doc: add license info to the README
7a34452
PR-URL: #36278
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@targostargos mentioned this pull request Dec 22, 2020
Merged
targos pushed a commit that referenced this pull request May 1, 2021
@iam-frankqiu@targos
doc: add license info to the README
647ec70
PR-URL: #36278
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@danielleadamsdanielleadams mentioned this pull request May 3, 2021
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aduh95aduh95aduh95 approved these changes
@TrottTrottTrott approved these changes
@jasnelljasnellAwaiting requested review from jasnell
+1 more reviewer
@mhdawsonmhdawsonmhdawson approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@iam-frankqiu@Trott@aduh95@jasnell@mhdawson@nodejs-github-bot