Credit localization contributors

[amyjko]

What's the problem?

There's no where in the application were we credit localization contributors.

What's the design idea?

Provide some place to give credit, and a way to store who contributed. GitHub is a partial ground truth for this, but it's not complete, since some contributors are not contributing through GitHub. We also have to decide where to display this credit.

Who benefits?

Everyone who contributed and future contributors.

Design specification

Designer: Junna Cao, Olivia Wei, Carol Yan

1. Separate page

• Users are able to view all the contributors through the button on the home page. All the teams will be listed on this page. We design the page specifically for the Localization team. To express appreciation for the contributors of WordPlayPen, we have added the clapping hands emoji '👏' spreading all the page. This design emphasizes creative expression and encourages users to acknowledge and thank the contributors of WordPlayPen in a positive and symbolic manner. Emoji hands will include all the colors without specifying by contributors. These hands represent users' appreciation. Contributors in different locales are listed in the different areas. The contributors' names in each locale are listed randomly. This has been noticed on the page.

• Add a contributor button on the home page

  

• A page for all "Contributors". Leadership roles will have a place for short introductions and will be directly displayed on this page. All other teams will be redirected to a separate page by clicking the corresponding team name. Considering the poor accessibility of adding images, we could also ask leaders to choose one emoji to represent themselves.

  

• Page for Localization team: After clicking "localization" from the previous page, it will redirect to this page.

  

• We intended to use color to represent the active/inactive. The status of the contributor need to be updated regularly

  

2. Language and Culture

• The design of the localization team displaying the contributors' names will feature country-specific emojis that represent each language. Emojis have higher accessibility since they have built-in image descriptions. Each locale will have different emojis. Members in the locale will choose this. This element not only adds a personalized touch but also celebrates the cultural heritage of the language selected.

3. Contributors name collection

• Considering the burden of managing outside the repository, we will collect the contributor’s name through GitHub commits history. Thus, we can draw directly from the locale file to render contributors.

• The role will come from Github. Everyone may have a team shown on GitHub:

  

• For the contributors who just submit pull requests, we are considering adding a "more contributor" section, and their names will come from the pull histories.

• What's more, all the other contributors(not in the team listed) will be credited in "more contributor" section.

[oliviawei1102]

Me, @JunnaC, and Carol want to work on this issue.

[amyjko]

Wonderful, let us know how we can help!

[JunnaC]

Hii @amyjko, Olivia, Carol, and I updated the design spec of this issue. Please let us know where we could improve. Thanks!!!

[amyjko]

Congratulations on an excellent first draft! Things I like:

• The celebratory interaction built in to language selection
• The inclusion of cultural ideas and imagery

Things to improve or design:

• From an accessibility perspective, popups are generally quite bad. We use them sparingly, only for dialogs that have an extensive amount of interaction to navigate (e.g., language chooser, settings), following WCAG guidelines. A popup inside of a popup is definitely a violation of WCAG guidelines. Think of a different way to share contributors and signal applause that doesn't make screen reader interactions harder?
• Gathering information from locale contributors is definitely key, but we already have some of it from GitHub commits that people have made. I'm thinking we need something that's more directly archived in a locale itself, such as a new field in the locale files that includes a list of names. That way there's less to manage outside the repository, and we can draw directly from the locale file to render contributors, rather than having to wrangle a Google Form, have someone responsible for monitoring it, and then having them enter contributor information into the locale file. We should just do that directly as part of contributions.
• We generally avoid images because of their poor accessibility, with the exception of emojis, since they have built in image descriptions. Can you think of ways of having cultural imagery using emojis only, or by having other Unicode symbols selected? Or do you think an image is essential? Would their be one image or symbol per locale? Who would choose these?
• How will your design scale to support hundreds, or thousands of locale contributors?
• What order will contributors be listed in? Does order have meaning, or is it random, or alphabetized?
• Would there be anywhere else someone could see locale contributors, or only on the language chooser? (e.g., if we were to create a page that credited all contributors, not just locale contributors, would it also appear there?)

[JunnaC]

Hii @amyjko, thanks for your instructions. We are having a meeting now. Here are our ideas/several questions

• We are now thinking of creating a separate page for contributors and putting it on the home page below the donation. Thus, when users click it, they will see the list of all contributors on a new page. For now, we will focus on designing the localization team.
• Question here: 1) Could you give us a direction for the file location/file name(which contains the contributor information)? 2)Does the contributor information contain all contributors in the localization team? (you mentioned there are SOME of it from Github commits). If not, we think using a Google form would potentially be a better idea, since we think it's also very necessary to get consent from contributors to display their names on the public website. 3) Other than the GitHub commits, How has the collaborators' information been collected?
• Images are not necessary, using emojis would also work for our ideas. we are thinking of putting multiple emojis per locale to show the cultural diversity. Localization contributors will choose these emojis.
• The order of contributors will be listed randomly. We will note this order on the page.
• We plan to design a separate page that could support crediting large-scale of contributors.

[amyjko]

• A separate page could be good
• There is no file that contains contributor information; it's all part of GitHub commits currently. GitHub stores their names. The key part is reducing administrative overhead on this; we don't want to forget to credit someone, we don't want to have to remember to pull information from a spreadsheet. That is the value of using GitHub's record of contributions.
• I look forward to the next design revision.

[JunnaC]

Hii @amyjko

Olivia, Carol, and I updated the design spec of this issue based on feedback. Please let us know where we could improve more :)) Thanksss.

[amyjko]

Nice iteration! I like the idea of showing all contributors, and pulling from GitHub. A few thoughts about this iteration:

• If we're pulling from GitHub, how would we determine emoji hand colors? That isn't specified anywhere on GitHub. Where would contributors specify it?
• Roles aren't very stable; students come and go, change roles, etc. What do you imagine these roles reflecting: the current status, past status of contributors? Where would this information come? GitHub, or some other source?
• There are many contributors that do not have a role in the project; they just submit pull requests, and are not part of the GitHub "teams". How would you represent their contributions?
• You mentioned images. Where would these images come from?

[JunnaC]

Hey @amyjko, thanks for your feedback! Here is our discussion idea:

• Emoji hands will include all the colors without specifying by contributors. These hands represent users' appreciation.
• The role will come from Github. Everyone may have a team shown on GitHub:

We intended to use color to represent the active/inactive. The status of the contributor need to be updated regularly

• For the contributors who just submit pull requests, we are considering adding a "more contributor" section, and their names will come from the pull histories. What's more, all the other contributors(not in the team listed) will be credited in "more contributor" section.
• Considering the poor accessibility of adding images, we could also ask leaders to choose one emoji to represent themselves.

[amyjko]

This all seem reasonable to me. There is some chance I'll be changing the use of GitHub teams, as it's caused many problems, but that would just mean that there are many few people on teams, and many more external contributors. Incorporate these into the proposal on top and this should be ready for design approval.

[JunnaC]

Hii @amyjko, we just updated our design spec, looking forward to getting the approval :))

[amyjko]

Thank you all, design approved. If your work ends here (you won't be building this), you can unassign yourself, so that others know it is free to work on. Congratulations!

[nathanbek]

Hey Amy I can take this issue!

[amyjko]

Assigned! I'm glad we can finally build this.