Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically spit all contributors into an AUTHORS.md or CONTRIBUTORS.md file #46

Closed
RichardLitt opened this issue Nov 1, 2017 · 13 comments

Comments

@RichardLitt
Copy link
Member

This should be possible, with the name of the user and a link. Perhaps a shim tool would be best, on top of this?

@tgetgood
Copy link
Collaborator

tgetgood commented Nov 1, 2017

So you mean convert the json into a markdown list? Simple enough. I think something downstream from this tool might make the most sense. Do you have templates for the md files?

@RichardLitt
Copy link
Member Author

Yes. I have two templates:

- [@username](https://github.com/username]

and

USERNAME
USERNAME2

Pretty simple, really. Let's make a companion module, maybe?

@tgetgood
Copy link
Collaborator

Agreed. A simple downstream script like whodunnit is probably best.

@RichardLitt
Copy link
Member Author

Another great one would add the contributors to the package.json in the contributors field.

@tgetgood
Copy link
Collaborator

I've added a --md option to whodidwhat which outputs the contributor list (sorted by gross number of contributions) in the first markdown format above.

Does that suffice for this need?

@RichardLitt
Copy link
Member Author

Not quite. I need two other formats:

User Name <email>

This should match git authors.

And, I need something that works for npm for the package.json: https://docs.npmjs.com/files/package.json#people-fields-author-contributors

So:

{ "name" : "Barney Rubble"
, "email" : "b@rubble.com"
, "url" : "http://barnyrubble.tumblr.com/"
}

Or "Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)".

@Berkmann18
Copy link
Collaborator

Was there any progress on this?

@RichardLitt
Copy link
Member Author

Doesn't look like it. :)

@Berkmann18
Copy link
Collaborator

Hum, okay, would it be better as a separate package or do you think it should be integrated into NYC?

@RichardLitt
Copy link
Member Author

I think this was the original conception behind https://github.com/mntnr/whodidwhat. Haven't checked in a bit. That may close this issue.

@Berkmann18
Copy link
Collaborator

That makes sense.

@RichardLitt
Copy link
Member Author

I'm still not convinced that whodidwhat needs to be a different module, though. But it does resolve this.

@Berkmann18
Copy link
Collaborator

Good to know, I was initially wondering if, given the use cases, another package or an extension to whodidwhat or NYC needed to be made.

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

No branches or pull requests

3 participants