docs: Update README generation #5147
Conversation
- Reword `Team` section to `Contributors` since the list is only partly team members. - Indicate in the contributors list who are a team member of the `golangci` organization - Update styling on the table to ensure equal sized image and name alignment - Always link to the user's GitHub profile instead of external web page
bombsimon
force-pushed
the
readme-generation
branch
from
ba5aa84 to
7af4a38
Compare
|
I agree with your PR. I also think replacing this section with something simpler, because, as you said, it takes more than 1 hour to generate. I think we should keep contributors but with something simpler, like inside the homepage https://golangci-lint.run/. And keep the "sort by activities" only for team members. |
Yeah I was thinking of removing I guess if we only take contributors from the contributors API we wouldn't need any more stats for them, however I would probably have to spend way more time figuring this out hence I filed this PR to fix styling and title short term. |
|
|
FYI I already tried to hack with |
|
If you agree, I propose to remove all the sections (and the CI process) to just use the contributors list #5147 (comment) In the future, we can improve or extend that, but it can be a good first step. |
This sounds way better and simpler! Sure, I'll miss my face there, but I'll survive! Closing this in favor of #5148 |
Teamsection toContributorssince the list is only partly team members.golangciorganizationI don't think linking to a user's external web page is what's expected when clicking on a user's picture here on GitHub. On top of that we also don't have control on what potential sites we're linking to by doing so. Instead I think we should always link to the GitHub profile page and if someone want's to visit the web page from there they can click on the link in the profile.
While exploring this I noticed a few other things that I was addressing since they felt related. I reworded the list to contributors since it's not actually the team or team members. To address that I also made an extra call to the organization's team page to flag contributors who's also team members. This is not optimal and could be handled with a single call and some more code changes but given that the pipeline takes 1h 12m I don't think an extra roundtrip and loop over 500 items really matters.
Lastly since the images and alignment was rendered differently if the name was long enough to cause a line break I added some styling for that as well.