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

Epic: Create Issues for removing closing slash from img tags #5040

Closed
73 tasks done
Tracked by #4362
roslynwythe opened this issue Jul 20, 2023 · 32 comments
Closed
73 tasks done
Tracked by #4362

Epic: Create Issues for removing closing slash from img tags #5040

roslynwythe opened this issue Jul 20, 2023 · 32 comments
Labels
Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level epic Feature: Refactor HTML Issue Making: Level 2 Make issue(s) from an ER or Epic role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours

Comments

@roslynwythe
Copy link
Member

roslynwythe commented Jul 20, 2023

Dependency

Epic for img tag auditing

Issues for removing closing slash:

Overview

We need to prepare the template and instructions for the issues that will remove the closing slash from img tags that have been audited in the HfLA-Website: img Tag Audit spreadsheet1

Action Items

  • Prepare issue templates

  • Review and (if needed) edit the following in the HfLA-Website: img Tag Audit spreadsheet:

    • The "Instructions for img with Ending Slash Issue Writers" section on the Instructions tab 1
    • Add additional sections or instructions as needed to the Instructions tab if needed
  • Get approval from a PM on the template(s).

2B: Good first issue writing session

  • After approval is given, ask a dev lead (a Merge Team member or Technical Lead) if you can do an issue writing session (or more than one session) during one of the meetings so that other developers on the team can help with writing the issues using the template(s).

Resources/Instructions

Footnotes

  1. HfLA-Website: img Tag Audit spreadsheet 2

@roslynwythe roslynwythe added Feature: Refactor HTML size: 1pt Can be done in 4-6 hours role: dev leads Tasks for technical leads Draft Issue is still in the process of being created Issue Making: Level 2 Make issue(s) from an ER or Epic Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level labels Jul 20, 2023
@roslynwythe
Copy link
Member Author

roslynwythe commented Jul 20, 2023

Issue Template for updates to HTML and JavaScript files

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 and attend an onboarding session.
  2. Before you claim or start working on an issue, please make sure you have read our How to Contribute to Hack for LA Guide.

Overview

We want to change an img HTML tag ending with a slash (<img.../>) to an img tag without an ending slash (<img...>) so that the codebase is consistent with how we use img HTML tags.

Action Items

  • In your local IDE, navigate to [INSERT PATH TO FILE HERE]
  • Remove the ending slash in the img HTML tag by changing
[INSERT LINE OF CURRENT CODE HERE]

to

[INSERT DESIRED LINE OF CODE HERE]

- [ ] The file may contain more than one instance of an img tag with a closing slash. Only change the single instance specified above. Do not leave any blank spaces before the closing bracket.

  • Using Docker, check the page remains the same in mobile, tablet, and desktop views as on the current website (See 1 in the Resources/Instructions section below)

Merge Team

Resources/Instructions

  1. Webpage(s): [INSERT LINK TO PAGE ON WEBSITE HERE]
  2. This issue is tracked in HfLA-Website: img Tag Audit spreadsheet's img with Ending Slash tab, and Epic: Create Issues for removing closing slash from img tags #5040

@Josiah-O Josiah-O added this to the x. Technical debt milestone Jul 22, 2023
@roslynwythe roslynwythe removed the Draft Issue is still in the process of being created label Jul 25, 2023
@roslynwythe roslynwythe self-assigned this Jul 25, 2023
@roslynwythe
Copy link
Member Author

roslynwythe commented Jul 25, 2023

@ExperimentsInHonesty since there was an urgent need for good first issues, I self-assigned it and started creating the issues before this Epic was approved. There was only one change to the previously approved template, the addition of this Action Item:

- [ ] The file may contain more than one instance of an img tag with a closing slash. Only change the single instance specified above. Do not leave any blank spaces before the closing bracket.

@roslynwythe roslynwythe added the Draft Issue is still in the process of being created label Jul 25, 2023
@roslynwythe
Copy link
Member Author

roslynwythe commented Jul 25, 2023

Issue Template for updates to CONTRIBUTING.md

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 and attend an onboarding session.
  2. Before you claim or start working on an issue, please make sure you have read our How to Contribute to Hack for LA Guide.

Overview

We want to change an img HTML tag ending with a slash (<img.../>) to an img tag without an ending slash (<img...>) so that the codebase is consistent with how we use img HTML tags.

Action Items

  • In your local IDE, open the file CONTRIBUTING.md
  • In Section [INSERT SECTION NUMBER] change
[INSERT LINE OF CURRENT CODE HERE]

to

[INSERT DESIRED LINE OF CODE HERE]

- [ ] The file may contain more than one instance of an img tag with a closing slash. Only change the single instance specified above. Do not leave any blank spaces before the closing bracket.

  • Changes to CONTRIBUTING.md cannot be tested locally, rather they must be tested after pushing the issue branch to your fork of the repository. Push your issue branch in the usual manner, but before creating the Pull Request, check your updates using this test URL (also store the test URL for use in a later step)
https://github.com/[REPLACE WITH GITHUB HANDLE]/website/blob/[REPLACE WITH NAME OF ISSUE BRANCH]/CONTRIBUTING.md

(for example: https://github.com/roslynwythe/website/blob/test-CONTRIB/CONTRIBUTING.md)

  • Create a pull request with your changes. In the Pull Request, after the "Why did you make the changes" section, add this line to help reviewers, replacing the text in brackets (and the brackets) with the test URL from the previous Action Item.
For Reviewers: Do not test changes locally, rather test changes at [REPLACE WITH TEST URL]

Merge Team

Resources/Instructions

  1. Webpage(s): https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md
  2. This issue is part of epic: Refactor img tags in CONTRIBUTING.md to end without a slash #6453

@roslynwythe roslynwythe removed the Draft Issue is still in the process of being created label Jul 25, 2023
@nitin-pandita

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level epic Feature: Refactor HTML Issue Making: Level 2 Make issue(s) from an ER or Epic role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours
Projects
Development

No branches or pull requests

5 participants