Add a Contributing Guidelines file #314

gdams · 2017-01-09T19:09:07Z

We should have a contributing guidelines file:

Inital Draft, open to ideas

gdams · 2017-01-09T19:09:22Z

gdams · 2017-01-26T20:13:48Z

Using ./CONTRIBUTING.md in the PR template resolves to https://github.com/nodejs/citgm/compare/CONTRIBUTING.md. Use the full path instead (as is done in Node.js core). Note that the CONTRIBUTING.md file hasn't yet been added (the PR to add it is nodejs#314).

gibfahn · 2017-02-16T05:18:33Z

Also can you change the commit subsystem from docs: to doc:?

gibfahn · 2017-02-16T14:05:05Z

Incidentally, given that node-review works in citgm, it's pretty straightforward to include the PR-URL: and Reviewed-By: labels in PRs. I think including PR-URL: is definitely worth it for landing other people's commits.

MylesBorins · 2017-02-16T17:53:49Z

@gibfahn we originally decided not to include all the meta data to make it a lower barrier to entry for contributing. I'm open to introducing it if @nodejs/citgm is on board

MylesBorins · 2017-02-17T09:10:36Z

@gibfahn one thing to mention, node-review will only count LGTM's from people who are a core collaborator, since it is hardcoded. The fact that it "mostly" works is a happy accident

Using ./CONTRIBUTING.md in the PR template resolves to https://github.com/nodejs/citgm/compare/CONTRIBUTING.md. Use the full path instead (as is done in Node.js core). Note that the CONTRIBUTING.md file hasn't yet been added (the PR to add it is nodejs#314).

gibfahn · 2017-02-20T08:22:37Z

@MylesBorins good points. Okay, so how about optionally using PR-URL: and not bothering with the rest?

MylesBorins · 2017-02-20T15:16:40Z

Sgtm

Using ./CONTRIBUTING.md in the PR template resolves to https://github.com/nodejs/citgm/compare/CONTRIBUTING.md. Use the full path instead (as is done in Node.js core). Note that the CONTRIBUTING.md file hasn't yet been added (the PR to add it is #314).

gdams · 2017-02-27T08:26:49Z

SGTM

gdams · 2017-02-27T11:27:55Z

@nodejs/citgm I think this is ready, could I get some reviews please?

MylesBorins · 2017-02-27T14:55:48Z

I feel like the commit guidelines are overkill.if we are not generating a changelog do we really need anything more than a descriptive title?

gibfahn · 2017-02-28T11:28:17Z

I feel like the commit guidelines are overkill.

Which ones exactly? The 50 (imperative verb), leave a line, 72 is just the standard Git commit guidelines AFAIK. Subsystem we've been doing already.

Other than that are there any other rules?

EDIT: If you're saying that commits only need to be one line long, then I don't think that's forbidden by the current description.

targos · 2017-02-28T11:45:39Z

I think it's good to have some guidelines, even if we do not generate a change log.

MylesBorins · 2017-02-28T16:34:00Z

I'll concede. I was simply thinking that anything more than asking for a descriptive title was a bit much.

…

On Tue, Feb 28, 2017 at 6:45 AM, Michaël Zasso ***@***.***> wrote: I think it's good to have some guidelines, even if we do not generate a change log. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#314 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAecV90BvIjv8QDCh0N966RvhqVDRDWNks5rhAjkgaJpZM4LeneO> .

sxa · 2017-02-28T18:48:34Z

At the moment when a PR is created it points you to the guidelines at https://github.com/nodejs/citgm/blob/master/CONTRIBUTING.md - can I suggest removing that until this has landed?

gdams · 2017-02-28T18:53:52Z

@sxa555 this is about to be landed, no need to worry

gdams · 2017-03-01T16:19:07Z

@nodejs/citgm are we all happy with this now ?

gdams · 2017-03-02T09:03:46Z

@MylesBorins that leaves you then?

gdams added house keeping Documentation and removed house keeping labels Jan 9, 2017