Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upupdate "team" in README.md #796
Comments
|
Can you please layout what needs to be changed? I am new to this and want to contribute as well. |
|
@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. |
|
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 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. |
|
we already have a tool that can update the team in the README
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 --> |
|
@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. |
|
@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. |
|
@MylesBorins Alright, sorry! Thanks for explaining to me |


Documentation Is
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.