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

doc: revise Introducing New Modules #25975

Closed
wants to merge 1 commit into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Feb 7, 2019

Revise "Introducing New Modules" in the Collaborator Guide:

  • Improve clarity.
  • Remove passive voice.
  • Keep sentences short for ease of reading/scanning.
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Revise "Introducing New Modules" in the Collaborator Guide:

* Improve clarity.
* Remove passive voice.
* Keep sentences short for ease of reading/scanning.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Feb 7, 2019
@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 7, 2019
@@ -292,25 +292,23 @@ metadata. Raise a Pull Request like any other change.

### Introducing New Modules

Semver-minor commits that introduce new core modules should be treated with
extra care.
Treat commits that introduce new core modules with extra care.
Copy link
Member

Choose a reason for hiding this comment

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

Is it mentioned elsewhere that introducing a new core module is semver-minor?

Copy link
Member Author

@Trott Trott Feb 7, 2019

Choose a reason for hiding this comment

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

Not as far as I know. If it's desirable to have it here, I can add a sentence. I'd prefer to leave it out as it's self-evident and low-value (as someone else will certainly add the label if the author does not) and this doc is plenty long as it is. But I don't have a strong preference, so I'll yield if a Collaborator thinks it needs to be in there.

Copy link
Member

Choose a reason for hiding this comment

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

I don't really have a strong preference either. I guess if we do mention it it can go in the bullet list below (probably next to "Label with the tsc-review label.").

Copy link
Contributor

Choose a reason for hiding this comment

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

By definition it adds functionality, ergo, semver-minor.

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

Trott added a commit to Trott/io.js that referenced this pull request Feb 9, 2019
Revise "Introducing New Modules" in the Collaborator Guide:

* Improve clarity.
* Remove passive voice.
* Keep sentences short for ease of reading/scanning.

PR-URL: nodejs#25975
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@Trott
Copy link
Member Author

Trott commented Feb 9, 2019

Landed in 016c7b9

@Trott Trott closed this Feb 9, 2019
targos pushed a commit that referenced this pull request Feb 10, 2019
Revise "Introducing New Modules" in the Collaborator Guide:

* Improve clarity.
* Remove passive voice.
* Keep sentences short for ease of reading/scanning.

PR-URL: #25975
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@targos targos mentioned this pull request Feb 14, 2019
@Trott Trott deleted the introducing-new-modules branch January 13, 2022 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants