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

update "team" in README.md #796

Open
bnb opened this issue Jul 27, 2020 · 9 comments
Open

update "team" in README.md #796

bnb opened this issue Jul 27, 2020 · 9 comments
Labels

Comments

@bnb
Copy link
Member

@bnb bnb commented Jul 27, 2020

Documentation Is

  • Missing/Needed
  • Incorrect
  • Confusing
  • Not Sure?

Please Explain in Detail

seems that the "Team" section of the README.md is extremely outdated and slightly misleading.

https://github.com/nodejs/nodejs.dev#team

Your Proposal for Changes

Update to reflect current/correct context.

@bnb bnb added the docs label Jul 27, 2020
@bnb bnb changed the title update "team" update "team" in README.md Jul 27, 2020
@harsh07bharvada
Copy link

@harsh07bharvada harsh07bharvada commented Aug 11, 2020

Can you please layout what needs to be changed? I am new to this and want to contribute as well.

@marcustisater
Copy link

@marcustisater marcustisater commented Aug 11, 2020

@bnb what do you think about adding https://opencollective.com/ or maybe pull from GitHub https://api.github.com/repos/nodejs/nodejs.dev/contributors

Something to make it easier to keep updated.

@bnb
Copy link
Member Author

@bnb bnb commented Aug 11, 2020

This section is currently not correct: https://github.com/nodejs/nodejs.dev#team

@marcustisater I think pulling from the GitHub API is probably a good idea, though I'd prefer to also ensure we're listing the @nodejs/nodejs-dev team members as is the norm in the project - if there was a GitHub Action that would automatically list everyone in both of those (team and contributors), that'd be super awesome :)

@bnb
Copy link
Member Author

@bnb bnb commented Aug 11, 2020

For reference, the current team (not visible to non-org-members, hence me posting it):
image

@marcustisater
Copy link

@marcustisater marcustisater commented Aug 12, 2020

@bnb cool, I added this list as one section to the README.

We can get data from here https://api.github.com/repos/nodejs/nodejs.dev/collaborators but it requires this list to be public.

I think one cool way we did this for http://postcss.org/ was to display contributors on the website. Maybe we can include it somehow on the new website.

postcss-contributors

@MylesBorins
Copy link
Member

@MylesBorins MylesBorins commented Aug 12, 2020

we already have a tool that can update the team in the README

$ npm i -g node-core-utils
$ ncu-team sync README.md

You can see it being used in https://raw.githubusercontent.com/nodejs/modules/master/README.md you wrap the list of users in a comment

<!-- ncu-team-sync.team(nodejs/${TEAMNAME}) -->
<!-- ncu-team-sync end -->
@marcustisater
Copy link

@marcustisater marcustisater commented Aug 12, 2020

@MylesBorins Ah, that's very cool. I didn't notice that! 😅

In my opinion I think you should just list the actual team members in the README and then link to https://github.com/nodejs/nodejs.dev/graphs/contributors and https://github.com/nodejs/website-redesign/graphs/contributors as that list will just keep growing.

Or another idea could be to make a new team in nodejs org and invite the contributors (like Gatsby does) and then you can list with the ncu tool.

@MylesBorins
Copy link
Member

@MylesBorins MylesBorins commented Aug 12, 2020

@marcustisater to make my suggestion a bit more explicit, which is what we do in other groups.

We should update the readme to have the meta data to utilize ncu-sync, we should be more on top of running it.

Those links are not publicly visible to anyone outside the org.

If we need to do any sort of team cleanup that is kind of a separate issue.

@marcustisater
Copy link

@marcustisater marcustisater commented Aug 12, 2020

@MylesBorins Alright, sorry! Thanks for explaining to me 👍

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

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.