improve discovery of CoC #3774

ashleygwilliams · 2015-11-11T15:38:51Z

as we all know, many do not read CONTRIBUTING.md. given that the COC was buried at the bottom of that, i figured that moving the COC to a top level file, and then mentioning it in both the README.md and the CONTRIBUTING.md would make it hard to miss 😉

move CoC from CONTRIBUTING to top-level, separate COC file
add note/link in CONTRIBUTING
add note/link in README (both at beginning and in newcomer resources)

aredridel · 2015-11-11T15:58:15Z

Oh that is an improvement. I actually struggled to find it when I went to it for reference a couple months ago.

Trott · 2015-11-11T15:59:33Z

LGTM

bnoordhuis · 2015-11-11T16:08:18Z

LGTM but the commit log should follow the guidelines from CONTRIBUTING.md. :-)

ashleygwilliams · 2015-11-11T16:09:27Z

wanted to make sure it was all good before finalizing @bnoordhuis, amending the commit now.

ashleygwilliams · 2015-11-11T16:15:40Z

hoping this commit fits the guidelines. as a first time contributor here, i do think the instructions are a bit confusing. (perhaps that will be my next contribution!)

r? @bnoordhuis

bnoordhuis · 2015-11-11T16:18:23Z

I'd use doc: as the prefix but we can amend that when landing. LGTM but I'll leave it open for a bit so others can comment.

I agree the current CONTRIBUTING.md is not a paragon of clarity.

JungMinu · 2015-11-11T16:19:33Z

LGTM

ashleygwilliams · 2015-11-11T16:21:54Z

i can just amend now @bnoordhuis, that portion of the contributing is also very confusing as the topic wasn't clear to me. i just assumed that the label this PR was given is what should be used.

Fishrock123 · 2015-11-11T16:40:36Z

This is effectively a duplicate of #3722 .. I'll let you and @thealphanerd choose whichever one remains.

Fishrock123 · 2015-11-11T16:41:52Z

hoping this commit fits the guidelines. as a first time contributor here, i do think the instructions are a bit confusing. (perhaps that will be my next contribution!)

(It totally is.)

@ashleygwilliams May I suggest discussing in relation to #3726?

Fishrock123 · 2015-11-11T16:45:02Z

For reference, working_groups.md, collaborator_guide.md, and roadmap.md are probably less (immediately) valuable and should maybe be moved into the doc directory if people feel we are having to many ALLCAPS (/root) files.

ashleygwilliams · 2015-11-11T16:45:55Z

eee, @Fishrock123 , i should have checked. my bad. and re: the guidelines i'll czech @3726

and yeah i tend to agree re: /root files ... is doc the right name tho? is there an issue for this?

Fishrock123 · 2015-11-11T16:48:35Z

doc: is what we have been (primarily?) using. (git log --pretty=oneline --abbrev-commit | grep doc: will show a bunch of stuff like this.)

MylesBorins · 2015-11-11T16:57:49Z

More than happy to close my pr and move forward with this one. Mine did not
have the updated copy in Readme or collaborators.
On Nov 11, 2015 8:48 AM, "Jeremiah Senkpiel" [email protected]
wrote:

doc: is what we have been (primarily?) using. (git log --pretty=oneline
--abbrev-commit | grep doc: will show a bunch of stuff like this.)

—
Reply to this email directly or view it on GitHub
#3774 (comment).

chrisdickinson · 2015-11-11T17:24:43Z

CONTRIBUTING.md

-* Avoid the use of personal pronouns in code comments or
-  documentation. There is no need to address persons when explaining
-  code (e.g. "When the developer").
+[Please read it.](./CODE_OF_CONDUCT.md)


I think the reason the CoC was originally included in CONTRIBUTING.md is that this file is automatically linked by GitHub on the "open a PR" form. I might be imagining this, but I think there was some legal reason that that started happening, too, related to the developer's certificate of origin. Given that, it might be good to note to the readers coming in from that link that the CoC is a binding part of contributing to Node:

By submitting a pull request to, issue to, or commenting on a pull request or issue on any of the "nodejs/" repositories, or using the #node.js or #io.js IRC channels, you agree to abide by the Node.js [Code of Conduct](./CODE_OF_CONDUCT.md).

I'd rather not hold up the PR for that, though — it can be done separately.

I might be imagining this, but I think there was some legal reason that that started happening, too, related to the developer's certificate of origin

Correct. The DCO must be in the Contributing.md file because it gets linked to the first time you go to post a PR to a repo on GitHub. Similarly, we increase the likelyhood that someone will see the CoC if it is in that file for the same reason (although a link may be enough, i'm not the expert on these things).

Who do we talk to about determining if the link is enough?

If the link is not enough, maybe we could post it in full in CONTRIBUTING.md and in the separate file for linking purposes?

i'm happy to dump it in contributing as well for now til we shake out legal. seem ok? say the word and i'll amend

To be clear, there's no legal requirement on the CoC being in a specific place (only the DCO). The only consideration here is "how do we make it more likely they will find it." I don't know entirely how to answer that, my gut is that a link at the top of CONTRIBUTING might be found more easily than a large amount of text at the bottom, but i have no real data to back that up and i'm not an expert on where new contributors find information :)

oh yeah, duh. 💯 @mikeal i'll put it up at the top now.

mikeal · 2015-11-11T17:40:42Z

@Fishrock123 on moving the other top level files:

working groups documentation could either live in the governance doc or be linked from it and live in docs.
collaborator guide should be linked to in contributing and moved to docs
roadmap can probably be removed, it's from the io.js days and is mostly complete.
do we really need a LICENSE? j/k :P

ashleygwilliams · 2015-11-11T19:12:42Z

h'ok, moved the CoC mention to the top of CONTRIBUTING. this is gonna need a squash now. but i'm holding off until i'm certain there are no more changes. also don't want to lose all the comment history just yet.

jasnell · 2015-11-11T19:33:53Z

LGTM.
I'm going to be taking a shot at improving the contributors document this week, btw. @ashleygwilliams ...we can squash the commits when it's actually landed, no need for you to do that unless you wanna.

Fishrock123 · 2015-11-11T19:49:21Z

LGTM unless we need to do something more for the contribution guide legally.

ashleygwilliams · 2015-11-11T20:15:04Z

i like squashing @jasnell. uno momento, then ready for merge

- move CoC from CONTRIBUTING to top-level, separate COC file - add note/link in CONTRIBUTING - add note/link in README (both at top, and newcomer resources) - move CoC section in CONTRIBUTING to top of file

chrisdickinson · 2015-11-11T21:04:27Z

LGTM! Thanks for addressing my comment!

jasnell · 2015-11-11T21:15:52Z

LGTM

Fishrock123 · 2015-11-11T21:33:37Z

@ashleygwilliams Just a note, there's a whitespace error I saw while applying this, could you please set git config --global --add core.whitespace fix for the future? Thanks! :)

jbergstroem · 2015-11-12T03:24:50Z

I like this -- makes it easier to find. Some suggestions inline.

jbergstroem · 2015-11-12T18:05:37Z

@Fishrock123 Get your point. In the name of progress lets skip my feedback.

mikeal · 2015-11-12T18:21:06Z

Let's limit the scope of feedback to matters that make the CoC more discoverable and refrain from considering comments about its content :)

ashleygwilliams · 2015-11-12T18:27:10Z

agreed @mikeal. am happy to start another issue for that discussion, though i think we may need to appeal to higher authorities for actual changes.

it may also be a nice thing to sandbox in the inclusivity-wg: https://github.com/nodejs/inclusivity (in case you didn't know it existed @jbergstroem )

jasnell · 2015-11-12T18:45:07Z

👍 @mikeal ... I can get this landed. @ashleygwilliams unless you'd like to do so, I can make the s/TC/TSC replacement (#3774 (comment)) in the text when the commit is actually landed.

mikeal · 2015-11-12T18:48:31Z

+1 for landing.

- move CoC from CONTRIBUTING to top-level, separate COC file - add note/link in CONTRIBUTING - add note/link in README (both at top, and newcomer resources) - move CoC section in CONTRIBUTING to top of file PR-URL: #3774 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>

jasnell · 2015-11-12T19:23:14Z

Landed in d781cdc

jasnell · 2015-11-12T19:34:28Z

Just as a side note: I've submitted a feature request to Github suggesting that CODE_OF_CONDUCT.md files contained in the root of a project be promoted in the UI similar to how README.md and CONTRIBUTING.md files are promoted. Obviously we'll have to wait to see if they actually do something with the suggestion ;-)

nebrius · 2015-11-12T19:40:12Z

@jasnell +1, good idea

- move CoC from CONTRIBUTING to top-level, separate COC file - add note/link in CONTRIBUTING - add note/link in README (both at top, and newcomer resources) - move CoC section in CONTRIBUTING to top of file PR-URL: #3774 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>

MylesBorins · 2015-11-17T18:34:27Z

landed in v4.x-staging as 643d949

- move CoC from CONTRIBUTING to top-level, separate COC file - add note/link in CONTRIBUTING - add note/link in README (both at top, and newcomer resources) - move CoC section in CONTRIBUTING to top of file PR-URL: #3774 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>

Original commit log for libuv@e900006 follows: thread: add support for affinity (nodejs#3774) Backported thread affinity feature and related dependency commits from master. It will add support for those APIs: uv_cpumask_size, uv_thread_setaffinity, uv_thread_getaffinity. The supported platforms are Linux, Freebsd, and Windows. Empty implementations (returning UV_ENOTSUP) on non-supported platforms (such as OS X and AIX). Original commit log for libuv@64669fd follows: thread: add uv_thread_getcpu() (nodejs#3803) Add uv_thread_getcpu() api to get the cpu number on which the calling thread is running.

mscdex added the meta Issues and PRs related to the general management of the project. label Nov 11, 2015

ashleygwilliams force-pushed the coc branch from 4d9e951 to e231c35 Compare November 11, 2015 16:14

ashleygwilliams force-pushed the coc branch from e231c35 to 31c9cfa Compare November 11, 2015 16:22

Fishrock123 added the doc Issues and PRs related to the documentations. label Nov 11, 2015

chrisdickinson reviewed Nov 11, 2015
View reviewed changes

MylesBorins mentioned this pull request Nov 11, 2015

meta: move code of conduct to it's own file #3722

Closed

docs: improve discoverability of Code of Conduct

618fee3

- move CoC from CONTRIBUTING to top-level, separate COC file - add note/link in CONTRIBUTING - add note/link in README (both at top, and newcomer resources) - move CoC section in CONTRIBUTING to top of file

ashleygwilliams force-pushed the coc branch from b0296a4 to 618fee3 Compare November 11, 2015 20:16

jasnell closed this Nov 12, 2015

jasnell added the lts-watch-v4.x label Nov 12, 2015

ashleygwilliams deleted the coc branch November 12, 2015 19:58

MylesBorins mentioned this pull request Nov 17, 2015

v4.2.2+1 commit candidates nodejs/Release#57

Closed

MylesBorins added lts-landed-on-v4.x and removed lts-watch-v4.x labels Nov 17, 2015

MylesBorins added land-on-v4.x and removed lts-landed-on-v4.x labels Dec 17, 2015

jasnell mentioned this pull request Dec 17, 2015

Release 4.2.4 Planning #4321

Closed

qdaoming mentioned this pull request Nov 21, 2022

deps: cherry-pick libuv@e900006 and libuv@64669fd #45561

Closed

Clemens-git76 mentioned this pull request Apr 16, 2024

[Snyk] Upgrade d3 from 5.16.0 to 7.9.0 Clemens-git76/node#5

Open

improve discovery of CoC #3774

improve discovery of CoC #3774

Conversation

ashleygwilliams commented Nov 11, 2015

aredridel commented Nov 11, 2015

Trott commented Nov 11, 2015

bnoordhuis commented Nov 11, 2015

ashleygwilliams commented Nov 11, 2015

ashleygwilliams commented Nov 11, 2015

bnoordhuis commented Nov 11, 2015

JungMinu commented Nov 11, 2015

ashleygwilliams commented Nov 11, 2015

Fishrock123 commented Nov 11, 2015

Fishrock123 commented Nov 11, 2015

Fishrock123 commented Nov 11, 2015

ashleygwilliams commented Nov 11, 2015

Fishrock123 commented Nov 11, 2015

MylesBorins commented Nov 11, 2015

chrisdickinson Nov 11, 2015

Choose a reason for hiding this comment

mikeal Nov 11, 2015

Choose a reason for hiding this comment

nebrius Nov 11, 2015

Choose a reason for hiding this comment

ashleygwilliams Nov 11, 2015

Choose a reason for hiding this comment

mikeal Nov 11, 2015

Choose a reason for hiding this comment

ashleygwilliams Nov 11, 2015

Choose a reason for hiding this comment

mikeal commented Nov 11, 2015

ashleygwilliams commented Nov 11, 2015

jasnell commented Nov 11, 2015

Fishrock123 commented Nov 11, 2015

ashleygwilliams commented Nov 11, 2015

chrisdickinson commented Nov 11, 2015

jasnell commented Nov 11, 2015

Fishrock123 commented Nov 11, 2015

jbergstroem commented Nov 12, 2015

jbergstroem commented Nov 12, 2015

mikeal commented Nov 12, 2015

ashleygwilliams commented Nov 12, 2015

jasnell commented Nov 12, 2015

mikeal commented Nov 12, 2015

jasnell commented Nov 12, 2015

jasnell commented Nov 12, 2015

nebrius commented Nov 12, 2015

MylesBorins commented Nov 17, 2015