Skip to content

ER: Sometimes we use quotes around text in .md files and sometimes we don't #7540

Open

Description

@ExperimentsInHonesty

Dependency

Emergent Requirement - Problem

Inconsistent formatting rules for when to use quotes in markdown files

Issue you discovered this emergent requirement in

https://github.com/hackforla/website/blob/gh-pages/.github/ISSUE_TEMPLATE/project-profile-card-review-and-update.yml?plain

Date discovered

2024-09-29

Did you have to do something temporarily

  • YES
  • NO

Who was involved

@ExperimentsInHonesty @kgold2018

What happens if this is not addressed

developers are confused

Resources

Recommended Action Items

  • Make a new issue
  • Discuss with team
  • Let a Team Lead know

Potential solutions [draft]

We need to make an issue to research and recommend best practice, then audit the site for anomalies (making spreadsheet) for new good first issues to fix the quotes issue on each file.

Activity

  1. moved this from New Issue Approval to Emergent Requests in P: HfLA Website: Project Boardon Sep 29, 2024
  2. 16 remaining items

  3. moved this from Prioritized backlog to New Issue Approval in P: HfLA Website: Project Boardon Mar 24, 2025
  4. moved this from New Issue Approval to Ice box in P: HfLA Website: Project Boardon May 20, 2025
  5. added
    DependencyAn issue is blocking the completion or starting of another issue
    and removed on May 20, 2025
  6. self-assigned this
    on Feb 10, 2026
  7. HackforLABot commented on Feb 10, 2026

    @HackforLABot
    Contributor

    Hi @daras-cu, 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 :)

  8. daras-cu commented on Mar 20, 2026

    @daras-cu
    Member

    Next Steps

    • From Research and recommend best practice for using quotes around text in .md files #7565:
      • "our Markdown and YAML files should contain single quotes only around strings containing special characters or other data types i.e. numbers or Booleans that we want to treat as strings. This will involve removing some existing unnecessary quotes and possibly changing some double quotes to single."
    • We need to create an Epic issue to audit the .md and .yml files in our codebase for the following:
      • Unnecessary quotes
      • Double quotes
      • Missing quotes (in particular, some URLs with colons are missing quotes)
    • As part of the Epic, create a Google Sheet with one sheet to list the files to be audited, and a second sheet for auditors to fill in results. Some files may be excluded from the audit if they use Markdown only for formatting, e.g. CONTRIBUTING.md and GHA comment templates. Also create the following templates:
      • Regular issue for auditing a single .md file and adding the findings to the spreadsheet
      • Issue Making issue for creating the audit issues for a block of .md files (probably 10 files per issue)
    • See Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248 for a similar Epic
  9. removed their assignment
    on Oct 16, 2026
  10. removed
    DependencyAn issue is blocking the completion or starting of another issue
    on Oct 16, 2026
  11. moved this from Ice box to ERs and epics that are ready to be turned into issues in P: HfLA Website: Project Boardon Oct 16, 2026
  12. self-assigned this
    on Oct 19, 2026
  13. HackforLABot commented on Oct 19, 2026

    @HackforLABot
    Contributor

    Hi @anthonylo87, 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 :)

  14. anthonylo87 commented on Oct 19, 2026

    @anthonylo87
    Member

    i. Availability: M-F Evenings
    ii. ETA: 10/23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

Relationships

None yet

Development

No branches or pull requests

Issue actions