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

Ease listing contributors #277

Closed
wants to merge 26 commits into from
Closed

Conversation

clementbiron
Copy link
Member

@clementbiron clementbiron commented Oct 17, 2023

That changeset uses the all-contributorsrc file as a data source for contributors list on the website and adds a staff.json to display the different team members.

It's not easy to choose one or more types of contribution per contributor, and it's mandatory. I've made an initial proposal that can be improved, but I wanted to deliver it as quickly as possible. If you want to make suggestions, use the documentation on this subject.

@netlify
Copy link

netlify bot commented Oct 17, 2023

Deploy Preview for open-terms-archive-website ready!

Name Link
🔨 Latest commit 6abb0ad
🔍 Latest deploy log https://app.netlify.com/sites/open-terms-archive-website/deploys/655b6675920de90008e2080b
😎 Deploy Preview https://deploy-preview-277--open-terms-archive-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@clementbiron clementbiron requested a review from MattiSG October 17, 2023 13:47
Copy link
Member

@MattiSG MattiSG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be easier to pair on this 🙂

src/modules/OTA-api/data-components/Contributors.tsx Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
next.config.js Outdated Show resolved Hide resolved
src/modules/OTA-api/data-components/Contributors.tsx Outdated Show resolved Hide resolved
src/modules/OTA-api/data-components/Contributors.tsx Outdated Show resolved Hide resolved
.all-contributorsrc Outdated Show resolved Hide resolved
@clementbiron clementbiron force-pushed the ease-listing-contributors branch from 0cc3b21 to 8280236 Compare October 18, 2023 20:30
@clementbiron
Copy link
Member Author

@MattiSG Sorry for the force push, i needed to rebase in order the use the last Typescript test in CI. I've implemented the changes we discussed today, please review it again 🙏

@clementbiron clementbiron requested a review from MattiSG October 18, 2023 20:37
Copy link
Member

@MattiSG MattiSG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! It's probably worth having a quick chat regarding the CONTRIBUTING file 🙂
I'd also be happy for 10 minutes reviewing together the contribution types assigned to each contributor. It's not super important, but if we do add types, let's try to make them right 😉

.all-contributors.md Outdated Show resolved Hide resolved
"avatar_url": "https://avatars.githubusercontent.com/u/765477?v=4",
"profile": "https://github.com/avernois",
"contributions": [
"code"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was more mentoring / technical coaching.

"avatar_url": "https://avatars.githubusercontent.com/u/82889095?v=4",
"profile": "https://github.com/AaronjSugarman",
"contributions": [
"code"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we have categories, I'd like us to distinguish “code” from declarations 🙂

"avatar_url": "https://avatars.githubusercontent.com/u/46820105?v=4",
"profile": "https://github.com/mvidonne",
"contributions": [
"data",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is “data” used to distinguish contributions, or data analysis?

"avatar_url": "https://avatars.githubusercontent.com/u/41912392?v=4",
"profile": "https://github.com/AdrienFines",
"contributions": [
"code"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doc mostly.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Comment on lines +76 to +75
### How to add a type of contribution to a contributor

You can do this by editing the `.all-contributorsrc` file or by using the bot with `@all-contributors please add @<already_listed_contributor> for <new_contribution_type>`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no explanation in the CONTRIBUTING that a “contributor” needs to have a “contribution type”, nor a reference of which ones we use and the interpretation we give to it 🙂

@@ -1,6 +1,6 @@
{
"files": [
"README.md"
".all-contributors.md"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you tried /dev/null? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried and it doesn't work: Error: ENOENT: no such file or directory

Co-authored-by: Matti Schneider <[email protected]>
@clementbiron
Copy link
Member Author

There is no explanation in the CONTRIBUTING that a “contributor” needs to have a “contribution type”...

I deliberately didn't go into too much detail because a link to the All Contributors documentation and a command exemple seemed sufficient to me.

... nor a reference of which ones we use and the interpretation we give to it 🙂

Hopefully we won't need to explain how we use them, they'll just speak for themselves. But let's look at it in sync.

@MattiSG
Copy link
Member

MattiSG commented Nov 20, 2023

After discussion: maybe just clarify that we use data type for declarations 🙂

@clementbiron clementbiron mentioned this pull request Feb 21, 2024
@MattiSG MattiSG deleted the branch old March 22, 2024 12:38
@MattiSG MattiSG closed this Mar 22, 2024
@clementbiron clementbiron deleted the ease-listing-contributors branch December 16, 2024 14:02
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.

2 participants