NationalBankBelgium / stark

Modern client-side Web application framework based on Angular, Angular Material / Material Design, TypeScript, Redux, RxJS, ...
https://stark.nbb.be
Other
55 stars 23 forks source link

admin: add support for all-contributors #5

Open dsebastien opened 6 years ago

dsebastien commented 6 years ago

Cfr https://github.com/kentcdodds/all-contributors

add a ".all-contributorsrc" file. Example: https://github.com/alexjoverm/typescript-library-starter/blob/master/.all-contributorsrc

SuperITMan commented 6 years ago

Currently, the contributors are mentioned in the main package.json. Should we move them to a all-contributors file so ?

dsebastien commented 6 years ago

No, we need those there too for the npm registry :)

dsebastien commented 6 years ago

Also add the generation of the contributors list to all stark packages (packages/*/package.json) and for the root package.json

dsebastien commented 6 years ago

Starting point for the list:

"contributors": [
    {
      "name": "Dubois Sebastien",
      "email": "sebastien.dubois@nbb.be",
      "url": "https://www.nbb.be"
    },
    {
      "name": "Cedric Namotte",
      "email": "cedric.namotte@nbb.be",
      "url": "https://www.nbb.be"
    },
    {
      "name": "Alexis Georges",
      "email": "alexis.georges@nbb.be",
      "url": "https://www.nbb.be"
    },
    {
      "name": "Christopher Cortes",
      "email": "christopher.cortes@nbb.be",
      "url": "https://www.nbb.be"
    },
    {
      "name": "Robby De Laet",
      "email": "robby.delaet@nbb.be",
      "url": "https://www.nbb.be"
    }
  ],
SuperITMan commented 6 years ago

For this, I took a look on the all-contributorsrc file from typescript library-starter and they this content for contributors:

{
      "login": "SuperITMan",
      "name": "Alexis Georges",
      "avatar_url": "https://avatars.githubusercontent.com/u/10333565?v=3",
      "profile": "https://github.com/SuperITMan",
      "contributions": [
        "code",
        "tool"
      ]
 },

But we have this one:

{
      "name": "Alexis Georges",
      "email": "alexis.georges@nbb.be",
      "url": "https://www.nbb.be"
 }

Which design do we want ?

According to npmjs documentation, we should have the one we have currently.

That means if we follow all-contributorsrc, we won't be able to display all the contributors on npm. I think we should so duplicate the contributors in this file

Or maybe we should find another way than .all-contributorsrc...