doc: edit CONTRIBUTING.md for clarity etc. by Trott · Pull Request #12796 · nodejs/node

Trott · 2017-05-02T18:32:02Z

Minor improvements to CONTRIBUTING.md.

Checklist

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc

addaleax · 2017-05-02T18:34:10Z

CONTRIBUTING.md

I would be okay with keeping this line

I'm with @Trott less is more.

addaleax · 2017-05-02T18:34:33Z

CONTRIBUTING.md

80 characters :)

IMHO move this whole section (#### Dependencies) leave just this line with a bullet point.

Should find a better place for it.

addaleax · 2017-05-02T18:36:02Z

CONTRIBUTING.md

“A commit log should describe what changed and why” is still good advice, at least in theory…

Maybe we can keep this doc very succinct and put a link right at the top with something like "if you are new or relatively new to contributing to open source, check out this way more informative guide". The link would be to a guide with more general information like this? And it could go into lots of detail, including maybe even some of the stuff from #12744 and material like that?

I would suggest leave this line, and ref to where ever #12744 / #12791 lands
IMHO we should hoist this section one level to ## but take it out of the "workflow"
Move the whole "### commit guidelines" to Just before ## Additional Notes.

refack · 2017-05-02T18:53:57Z

👍 for the initiative!
I'm reading it eagerly now.
I have two suggestions: (1) add a ToC in the head (2) remove all the pure git stuff and refer to the GitHub tutorial. It'll cleanup this doc and the tutorial is very good (dare I say better than our comments 😉).

refack · 2017-05-02T18:55:15Z

CONTRIBUTING.md

I'm with @Trott less is more.

refack · 2017-05-02T18:57:26Z

CONTRIBUTING.md

IMHO move this whole section (#### Dependencies) leave just this line with a bullet point.

Should find a better place for it.

refack · 2017-05-02T19:03:14Z

CONTRIBUTING.md

I would suggest leave this line, and ref to where ever #12744 / #12791 lands
IMHO we should hoist this section one level to ## but take it out of the "workflow"
Move the whole "### commit guidelines" to Just before ## Additional Notes.

refack · 2017-05-02T19:05:24Z

CONTRIBUTING.md

I suggest move all the technical stuff except make test / vcbuild test to a new HOWTO test.md

refack · 2017-05-02T19:06:14Z

CONTRIBUTING.md

remove git GitHub stuff.

PR-URL: nodejs#12796 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

Trott · 2017-05-04T23:03:20Z

Landed in 0258aed

PR-URL: nodejs#12796 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

gibfahn · 2017-06-18T23:34:47Z

Doesn't land cleanly (probably relies on something else that wasn't backported). I'm assuming there's no real need to raise a backport PR (although if anyone wants to backport it then feel free).

nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 2, 2017

addaleax approved these changes May 2, 2017

View reviewed changes

refack reviewed May 2, 2017

View reviewed changes

mscdex added the meta Issues and PRs related to the general management of the project. label May 2, 2017

jasnell approved these changes May 2, 2017

View reviewed changes

doc: edit CONTRIBUTING.md for clarity etc.

298e7b3

Trott force-pushed the strawberry branch from 7eebf9e to 298e7b3 Compare May 4, 2017 05:48

Trott added a commit to Trott/io.js that referenced this pull request May 4, 2017

doc: edit CONTRIBUTING.md for clarity etc.

0258aed

PR-URL: nodejs#12796 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

Trott closed this May 4, 2017

anchnk pushed a commit to anchnk/node that referenced this pull request May 6, 2017

doc: edit CONTRIBUTING.md for clarity etc.

133d460

PR-URL: nodejs#12796 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

refack mentioned this pull request May 10, 2017

doc:spin off technical guide #12748

Closed

2 tasks

jasnell mentioned this pull request May 11, 2017

8.0.0 Release Proposal #12220

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

gibfahn added the dont-land-on-v6.x label Jun 18, 2017

Trott deleted the strawberry branch January 13, 2022 22:45

Uh oh!

Conversation

Trott commented May 2, 2017

Checklist

Affected core subsystem(s)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack May 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack commented May 2, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack May 2, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Trott commented May 4, 2017

Uh oh!

gibfahn commented Jun 18, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

refack May 2, 2017 •

edited

Loading

refack May 2, 2017 •

edited

Loading