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

Update Credits yml file template #2642

Closed
5 tasks done
JessicaLucindaCheng opened this issue Dec 28, 2021 · 3 comments
Closed
5 tasks done

Update Credits yml file template #2642

JessicaLucindaCheng opened this issue Dec 28, 2021 · 3 comments
Assignees
Labels
Complexity: Medium Feature: Wiki role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours

Comments

@JessicaLucindaCheng
Copy link
Member

JessicaLucindaCheng commented Dec 28, 2021

Overview

As a member of the team, we need to ensure the Wiki is an up to date and accurate resource. For this issue, we will update the Credits yml file template.

Action Items

This will be an issue worked on and discussed during development team meetings.

Resources/Instructions

@github-actions
Copy link

Hi @JessicaLucindaCheng.

Good job adding the required labels for this issue. The merge team will review the issue and add a "Ready for Milestone" label once it is ready for prioritization.

Additional Resources:

@JessicaLucindaCheng
Copy link
Member Author

All action items are completed, so I'm closing this issue.

@JessicaLucindaCheng
Copy link
Member Author

JessicaLucindaCheng commented Feb 14, 2022

Note about decisions made: For the Credits yml file template, originally, it had both the content and type field, which seemed similar in terms of its use, and neither field was used in the code itself. Thus, we decided to remove the type field because only one of the fields is necessary if they contain the same information. Also, we changed the content field to the content-type field to make the field name clearer for what its purpose is, which is type of content. In addition, we decided the content-type field should be standardized to only certain choices; for now, those are image, video, or audio but other types of content can be added in the future if necessary and should be added to the template so that every credit we create will use the same values for content-type. This will allow developers a way to differentiate easily between different content types in the future and display them correctly on the website if we start using different content types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Feature: Wiki role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours
Projects
Development

No branches or pull requests

3 participants