Skip to content

chore: Add Contributors section to readme #1144

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

Merged
merged 4 commits into from
Apr 27, 2022
Merged

Conversation

mafredri
Copy link
Member

This PR adds a Contributors-section to the readme as described in #1112. Additionally the date format was explicitly documented.

Subtasks (as part of my onboarding)

  • Add Contributors-section to readme
  • Add myself as contributor

Fixes #1112

@codecov
Copy link

codecov bot commented Apr 25, 2022

Codecov Report

Merging #1144 (81a9b13) into main (a769e86) will decrease coverage by 0.26%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1144      +/-   ##
==========================================
- Coverage   66.26%   65.99%   -0.27%     
==========================================
  Files         265      261       -4     
  Lines       16682    16482     -200     
  Branches      157      157              
==========================================
- Hits        11054    10877     -177     
+ Misses       4483     4470      -13     
+ Partials     1145     1135      -10     
Flag Coverage Δ
unittest-go-macos-latest 53.46% <ø> (-0.21%) ⬇️
unittest-go-postgres- 65.53% <ø> (-0.09%) ⬇️
unittest-go-ubuntu-latest 56.15% <ø> (-0.02%) ⬇️
unittest-go-windows-2022 ?
unittest-js 66.50% <ø> (ø)
Impacted Files Coverage Δ
peerbroker/listen.go 84.03% <0.00%> (-6.73%) ⬇️
cli/configssh.go 61.19% <0.00%> (-6.72%) ⬇️
coderd/httpapi/httpapi.go 66.25% <0.00%> (-6.25%) ⬇️
pty/ptytest/ptytest.go 86.95% <0.00%> (-4.35%) ⬇️
cli/templateinit.go 58.62% <0.00%> (-3.45%) ⬇️
agent/agent.go 63.12% <0.00%> (-3.20%) ⬇️
coderd/workspaceagents.go 55.59% <0.00%> (-2.56%) ⬇️
peer/conn.go 79.94% <0.00%> (-1.27%) ⬇️
peer/channel.go 83.23% <0.00%> (-0.58%) ⬇️
coderd/provisionerdaemons.go 62.79% <0.00%> (-0.51%) ⬇️
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a769e86...81a9b13. Read the comment docs.

@kylecarbs
Copy link
Member

I wonder if this could be autogenned? I've seen that on other repos before, but I'm having trouble finding them!

@mafredri
Copy link
Member Author

@kylecarbs I like that idea! I've seen things like actions/contributors-list which displays the users picture/name.

Are we ok with utilizing GitHub Actions for this? And do we want to include the extended information like first PR date and organization? The former may be queryable via GitHub API (need to verify), but as for the latter the user could be part of multiple organizations.

@mafredri mafredri force-pushed the mafredri/contributors branch from b9f5be3 to 975cdbe Compare April 27, 2022 11:36
Co-authored-by: Cian Johnston <public@cianjohnston.ie>
@mafredri mafredri enabled auto-merge (squash) April 27, 2022 11:43
@mafredri mafredri merged commit 0b1ee33 into main Apr 27, 2022
@mafredri mafredri deleted the mafredri/contributors branch April 27, 2022 11:48
@kylecarbs
Copy link
Member

@mafredri I was thinking we'd use something like: https://contrib.rocks/preview?repo=coder%2Fcode-server

@mafredri
Copy link
Member Author

Ah, that's actually a pretty nice solution to avoid having to re-generate the README. I suppose we would need a self-hosted solution to access the private repo? One downside with the image version is that you can't click to the users profile (if we consider that important).

@kylecarbs
Copy link
Member

That's true. I'd be in favor of using contributors-list in that case, I'm concerned that the manually maintained list will not be manually maintained 😁

@misskniss misskniss added this to the V2 Beta milestone May 15, 2022
kylecarbs pushed a commit that referenced this pull request Jun 10, 2022
Co-authored-by: Cian Johnston <public@cianjohnston.ie>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create Contributors section in README.md
4 participants