Skip to content
This repository has been archived by the owner on Nov 19, 2020. It is now read-only.

Write contributors into outputFiles rather than package.json #7

Closed
wants to merge 2 commits into from

Conversation

outsideris
Copy link

As @juergba said, putting all contributors on package.json doesn't make sense.

So, add an outputFile option to save all contributors on another file(e.g CONTRIBUTORS) than package.json.

Signed-off-by: Outsider <outsideris@gmail.com>
@outsideris outsideris changed the title Output Write contributors into outputFiles rather than package.json Oct 5, 2019
Signed-off-by: Outsider <outsideris@gmail.com>
@juergba
Copy link

juergba commented Oct 6, 2019

@outsideris this package is boneskull's baby, so IMO it's upto him to review.
Anyway the docu update in "README.md" is missing.

@boneskull
Copy link
Contributor

it was always in package.json, which is why I wrote the tool to put it there. there are other tools to generate a list of contributors and output to markdown...

but contributors.md is supposed to be a contribution guide, not a list of contributors.

so if we’re going to abandon writing to package.json (not sure why this is a problem, but haven’t investigated where this issue can from), then we should:

  1. use maybe AUTHORS.md to put the names
  2. don’t change this package, because it’s meant to write to package.json, and other tools do number 1
  3. use some other tool
  4. ensure the .md file is written to at publish time
  5. archive this package

@boneskull
Copy link
Contributor

and yes, to be more clear, there’s no reason for this package other than “we’ve always done it that way” which is a thin reason indeed

@outsideris
Copy link
Author

Sorry, I should discuss about that in advance. I didn't think it will be a problem to add a feature to this package.

I opened a issue to discuss them.

@outsideris outsideris closed this Oct 7, 2019
@boneskull
Copy link
Contributor

@outsideris don't worry! it's just that the problem of listing contributors in a markdown file has already been solved elsewhere. if that's the direction we're to go in, we shouldn't need to maintain our own software to do it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants