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

img tag refactor in CONTRIBUTING.md Section 3.1.b, iv #7835

Open
5 tasks
Tracked by #6453
dvernon5 opened this issue Jan 19, 2025 · 2 comments
Open
5 tasks
Tracked by #6453

img tag refactor in CONTRIBUTING.md Section 3.1.b, iv #7835

dvernon5 opened this issue Jan 19, 2025 · 2 comments
Labels
Feature: Refactor HTML Feature: Wiki good first issue Good for newcomers Ready for Prioritization role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.25pt Can be done in 0.5 to 1.5 hours

Comments

@dvernon5
Copy link
Member

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 3.1.b, iv change
- If your images are too big, use the <img src="" width="" length="" />  syntax instead of ![image](link) to format the images

to

- If your images are too big, use the <img src="" width="" length="">  syntax instead of ![image](link) to format the images

- [ ] 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
@dvernon5 dvernon5 added Feature: Refactor HTML good first issue Good for newcomers ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.25pt Can be done in 0.5 to 1.5 hours labels Jan 19, 2025
@daras-cu daras-cu added Ready for Prioritization and removed ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization labels Jan 22, 2025
@daras-cu
Copy link
Member

@dvernon5 this issue looks good as well, thanks for working on it!

@dvernon5
Copy link
Member Author

@daras-cu Thank you for your feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Refactor HTML Feature: Wiki good first issue Good for newcomers Ready for Prioritization role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.25pt Can be done in 0.5 to 1.5 hours
Projects
Status: New Issue Approval
Development

No branches or pull requests

2 participants