Code Monkey home page Code Monkey logo

Comments (13)

Berkmann18 avatar Berkmann18 commented on June 19, 2024 1

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.

from name-your-contributors.

tgetgood avatar tgetgood commented on June 19, 2024

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?

from name-your-contributors.

RichardLitt avatar RichardLitt commented on June 19, 2024

Yes. I have two templates:

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

and

USERNAME
USERNAME2

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

from name-your-contributors.

tgetgood avatar tgetgood commented on June 19, 2024

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

from name-your-contributors.

RichardLitt avatar RichardLitt commented on June 19, 2024

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

from name-your-contributors.

tgetgood avatar tgetgood commented on June 19, 2024

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?

from name-your-contributors.

RichardLitt avatar RichardLitt commented on June 19, 2024

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" : "[email protected]"
, "url" : "http://barnyrubble.tumblr.com/"
}

Or "Barney Rubble <[email protected]> (http://barnyrubble.tumblr.com/)".

from name-your-contributors.

Berkmann18 avatar Berkmann18 commented on June 19, 2024

Was there any progress on this?

from name-your-contributors.

RichardLitt avatar RichardLitt commented on June 19, 2024

Doesn't look like it. :)

from name-your-contributors.

Berkmann18 avatar Berkmann18 commented on June 19, 2024

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

from name-your-contributors.

RichardLitt avatar RichardLitt commented on June 19, 2024

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

from name-your-contributors.

Berkmann18 avatar Berkmann18 commented on June 19, 2024

That makes sense.

from name-your-contributors.

RichardLitt avatar RichardLitt commented on June 19, 2024

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

from name-your-contributors.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.