search

finnp / create-module

Helper to create a module
32 stars 4 forks source link

Feature: Add CONTRIBUTING.md scaffold #13

Open jtemplet opened 9 years ago

jtemplet commented 9 years ago

@dshaw suggested we should add a CONTRIBUTING.md file that outlines directions in contributing. https://github.com/nodeconf/Adventure-UNCONF/issues/21

One example provided by github themselves was puppet https://raw.githubusercontent.com/puppetlabs/puppet/master/CONTRIBUTING.md or from factory_girl_rails https://raw.githubusercontent.com/thoughtbot/factory_girl_rails/master/CONTRIBUTING.md

Should the scaffolding be a general outline? Something likes this? 1.) Check past issues to see if the feature request has been made. 2.) Something about suggesting/requesting in the project's issues page 3.) Fork the project 4.) Review the code 5.) branch code from master, add feature, test feature, push branch aka make pull request

:+1: or :-1:

klaemo commented 9 years ago

The way I see it we're getting into template territory here. ;) I don't think the defaults of this module should be too opinionated, but I see the usefulness of this and #8. Ideally, we should really setup some kind of templating mechanism as mentioned in #7 and #8.

@finnp I think we need a broader plan here for all these additions. I propose:

  1. create-module should remain usable as is without templates (default)
  2. We should somehow leverage https://github.com/mafintosh/create-project for all the advanced needs and provide some basic templates for Contributing.md etc (opt-in)
jtemplet commented 9 years ago

After thinking about it a bit more, I feel like for the Contributing.md file there should be some boilerplate, and some filled in by the developer on a per module basis.

Should the default run of create-module even create a Contributing.md file? If so, is it best to just be empty? Or maybe a reference to the github blog post about writing a Contributing.md file, or boilerplate text?

finnp commented 9 years ago

Sorry, I've been busy lately. I really would like to use create-project soon. But I still had some issues with that (see https://github.com/finnp/create-module/issues/7).

I am also not sure how to work with create-project and still have offline-support. Because that fetched the boiler plate from the internet each time. I have an unfinished PR for create-project that would be the first step to do it.

jtemplet commented 9 years ago

No worries, I've been working on gitonup issue #3 and the best way to go about doing this. Well, it's not the main problem holding me up, but hopefully I can resolve it soon.