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

Edit content field and remove type field from design.yml credits file #2818

Closed
5 tasks done
Tracked by #2775
tamara-snyder opened this issue Feb 20, 2022 · 3 comments · Fixed by #3445
Closed
5 tasks done
Tracked by #2775

Edit content field and remove type field from design.yml credits file #2818

tamara-snyder opened this issue Feb 20, 2022 · 3 comments · Fixed by #3445
Assignees
Labels
good first issue Good for newcomers P-Feature: Credit https://www.hackforla.org/credits/ role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less

Comments

@tamara-snyder
Copy link
Member

tamara-snyder commented Feb 20, 2022

Prerequisite

  1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our Getting Started page.
  2. Please make sure you have read our Hack for LA Contributing Guide before you claim/start working on an issue.

Overview

As a developer, I want to edit the content field and remove the type field from a credit's yml file so that redundant code is removed and the code is easier to understand.

Details

Currently, in each credit's yml file, there is a content field and a type field, which contains similar information. Since the fields are redundant, we decided to remove the type field.

Also, we changed the content field to the content-type field to make it clearer what its purpose is. The possible values for content-type field are image, video, or audio; other types of content can be added if necessary. In the future, this will allow developers a way to differentiate easily between different types of content in order to show each credit's media file correctly on the website.

Action Items

For the file _data/internal/credits/design.yml, do the following:

Resources/Instructions

File and Code links you will need to work on this issue

@tamara-snyder tamara-snyder added good first issue Good for newcomers role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers P-Feature: Credit https://www.hackforla.org/credits/ size: 0.5pt Can be done in 3 hours or less labels Feb 20, 2022
@github-actions

This comment was marked as outdated.

@JessicaLucindaCheng JessicaLucindaCheng changed the title Edit content field and remove type field from design.yml file Edit content field and remove type field from design.yml credits file Feb 24, 2022
@JessicaLucindaCheng JessicaLucindaCheng added this to the y. Technical debt milestone Mar 10, 2022
@CalvinTan607 CalvinTan607 self-assigned this Jul 31, 2022
@github-actions
Copy link

Hi @CalvinTan607, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

@CalvinTan607
Copy link
Contributor

i. Availability: 7/31
ii. ETA: Before the end of 7/31

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers P-Feature: Credit https://www.hackforla.org/credits/ role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less
Projects
Development

Successfully merging a pull request may close this issue.

4 participants