Skip to content

doc: fix doc style in doc/releases.md#19774

Closed
erwinwahyura wants to merge 4 commits into
nodejs:masterfrom
erwinwahyura:master
Closed

doc: fix doc style in doc/releases.md#19774
erwinwahyura wants to merge 4 commits into
nodejs:masterfrom
erwinwahyura:master

Conversation

@erwinwahyura

@erwinwahyura erwinwahyura commented Apr 3, 2018 •
edited
Loading

Copy link
Copy Markdown
Contributor
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@erwinwahyura erwinwahyura changed the title fix doc style in doc/release.md fix doc style in doc/releases.md Apr 3, 2018
@erwinwahyura erwinwahyura changed the title fix doc style in doc/releases.md doc: fix doc style in doc/releases.md Apr 3, 2018
Trott
Trott requested changes Apr 3, 2018
View reviewed changes

@Trott Trott 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.

Thanks for the PR, @erwinwahyura! The punctuation changes look good to me. A few things to fix up before landing, though!

Comment thread doc/releases.md Outdated

Collect a formatted list of commits since the last release. Use
[`changelog-maker`](https://github.com/rvagg/changelog-maker) to do this.
Collect a formatted list of commits since the last release. Use [`changelog-maker`](https://github.com/rvagg/changelog-maker) to do this:

@Trott Trott Apr 3, 2018

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.

I'm pretty sure this will fail linting because lines need to be wrapped at 80 characters.

Comment thread doc/releases.md Outdated

*Note*: `$VERSION` should be prefixed with a `v`

_Note_: `$VERSION` should be prefixed with a `v`.

@Trott Trott Apr 3, 2018

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.

The change from * to _ makes this inconsistent with the rest of our docs. Please change it back.

Although... even better perhaps, remove Note: entirely from the line.

@Trott Trott Apr 3, 2018

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.

Oh...looks like you added a line rather than editing the existing line. So the line is there twice.

@erwinwahyura erwinwahyura Apr 3, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

thats my bad, i will change it back. thank you

@erwinwahyura erwinwahyura reopened this Apr 3, 2018
Trott
Trott approved these changes Apr 3, 2018
View reviewed changes

@Trott Trott 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. Thanks!

@Trott

Trott commented Apr 3, 2018

Copy link
Copy Markdown
Member

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/403/

@Trott Trott closed this Apr 3, 2018
@Trott Trott reopened this Apr 3, 2018
@vsemozhetbyt vsemozhetbyt added doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. fast-track PRs that do not need to wait for 72 hours to land. labels Apr 3, 2018
@vsemozhetbyt

vsemozhetbyt commented Apr 3, 2018

Copy link
Copy Markdown
Contributor

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/404/

@vsemozhetbyt

vsemozhetbyt commented Apr 3, 2018

Copy link
Copy Markdown
Contributor

@Trott What is wrong with CI? What merge conflict is this?

@vsemozhetbyt

vsemozhetbyt commented Apr 3, 2018

Copy link
Copy Markdown
Contributor

There is a huge intermediate commit "Merge branch 'master' into master". Maybe it breaks the CI.

@vsemozhetbyt vsemozhetbyt removed the fast-track PRs that do not need to wait for 72 hours to land. label Apr 3, 2018
@Trott

Trott commented Apr 3, 2018

Copy link
Copy Markdown
Member

@vsemozhetbyt It's not starting because there's a merge commit in this PR. @erwinwahyura or you (or me or someone else) can squash it out and then CI should start.

@targos

targos commented Apr 3, 2018 •
edited
Loading

Copy link
Copy Markdown
Member

You can also set REBASE_ONTO to <no rebasing> and I believe it should work.

@Trott

Trott commented Apr 3, 2018

Copy link
Copy Markdown
Member

Thanks @targos! I didn't know about that!

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/408/

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 9, 2018
@trivikr

trivikr commented Apr 9, 2018

Copy link
Copy Markdown
Member

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/465/

@trivikr

trivikr commented Apr 9, 2018

Copy link
Copy Markdown
Member

Lite CI with <no rebasing> https://ci.nodejs.org/job/node-test-pull-request-lite/467/

@trivikr

trivikr commented Apr 9, 2018

Copy link
Copy Markdown
Member

Looks like code change was done in master branch (instead of private branch suggested in step 2) of the fork which was five months old, and then the merge commit was created (instead of rebasing recommended in step 9)

I'm not able to successfully rebase the two commits belonging to this PR with a merge commit in between.
@Trott / @BridgeAR Can you take a look?

BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Apr 9, 2018
@erwinwahyura @BridgeAR
doc: fix punctuation in doc/releases.md
38c97f5 
PR-URL: nodejs#19774
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BridgeAR

BridgeAR commented Apr 9, 2018

Copy link
Copy Markdown
Member

Landed in 38c97f5 🎉

I fixed the commit message while landing.

@BridgeAR BridgeAR closed this Apr 9, 2018
targos pushed a commit that referenced this pull request Apr 12, 2018
@erwinwahyura @targos
doc: fix punctuation in doc/releases.md
b200565 
PR-URL: #19774
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnell jasnell jasnell approved these changes
@Trott Trott Trott approved these changes
@BridgeAR BridgeAR BridgeAR approved these changes
@trivikr trivikr trivikr approved these changes
+1 more reviewer
@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

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. meta Issues and PRs related to the general management of the project.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@erwinwahyura @Trott @vsemozhetbyt @targos @trivikr @BridgeAR @jasnell