search

hackforla / website

Hack for LA's website
https://www.hackforla.org
GNU General Public License v2.0
325 stars 778 forks source link

Research and recommend best practice for using quotes around text in .md files #7565

Open codyyjxn opened 1 month ago

codyyjxn commented 1 month ago

Overview

We need to research and recommend best practice so that we can audit the site to determine which quotes or lack of quotes need to be fixed.

Details

Here is an example of two text items in the same file.

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

https://github.com/hackforla/website/blob/271a82e89f55bdeeb80677403558228aee2bbe24/.github/ISSUE_TEMPLATE/project-profile-card-review-and-update.yml?plain=1#L224

https://github.com/hackforla/website/blob/271a82e89f55bdeeb80677403558228aee2bbe24/.github/ISSUE_TEMPLATE/project-profile-card-review-and-update.yml?plain=1#L233

Here are examples from two different project .md files. Notice that first one one uses a double quote and the second uses a single quote for the same type of link https://github.com/hackforla/website/blob/53e798a794d43ab507acf68f1ebbabf2a54b9bf0/_projects/food-oasis.md?plain=1#L90

https://github.com/hackforla/website/blob/53e798a794d43ab507acf68f1ebbabf2a54b9bf0/_projects/100-automations.md?plain=1#L53

Action Items

Resources

github-actions[bot] commented 1 month ago

Hi @codyyjxn.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:

NOTE: Please ignore this comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards. To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

ExperimentsInHonesty commented 1 month ago

There is an issue template for issues and an issue template for ER. This issue has an ER title, but is written as an issue. It needs to be written as an ER which outlines the problem, and defines the issues to be made. It can also include a solution outline or draft.

What is written above is a mashup of both. So I recommend you put a pause on this issue. Create an ER that outlines the issues that will need to be made. Get sign off on the approach, and then revise this issue to be the epic for the audit issues.

If that make sense go ahead, or if you want to discuss further, I am available on Sunday at the 10am meeting or Monday at 5pm at the dev/pm meeting.

ExperimentsInHonesty commented 1 month ago

@codyyjxn There is an issue template for issues and an issue template for ER. This issue has an ER title, but is written as an issue. It needs to be written as an ER which outlines the problem, and defines the issues to be made. It can also include a solution outline or draft.

What is written above is a mashup of both. So I recommend you put a pause on this issue. Create an ER that outlines the issues that will need to be made. Get sign off on the approach, and then revise this issue to be the epic for the audit issues.

If that make sense go ahead, or if you want to discuss further, I am available on Sunday at the 10am meeting or Monday at 5pm at the dev/pm meeting.

HackforLABot commented 1 month ago

Hello @codyyjxn, we appreciate you taking on this issue, however it looks like you're already working on another issue at this time. Please wait until your current issue is merged before taking on another issue. :)

We are going to unassign you from this issue so you can focus on your current issue.

Hfla appreciates you! :)

HackforLABot commented 1 month ago

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

ExperimentsInHonesty commented 1 month ago

@codyyjxn

ExperimentsInHonesty commented 1 month ago

@codyyjxn I think you missed what you were supposed to do for this issue.

  1. write this issue so that it has action items that achieve the scope listed in the overview

We need to research and recommend best practice so that we can audit the site to determine which quotes or lack of quotes need to be fixed.

The current draft of the action items, tell the person to make the changes, which is premature given that no one has done the research and recommendations yet. I am not asking you to do the research and recommendations, but rather write an issue for someone to do it.

codyyjxn commented 3 weeks ago

@codyyjxn I think you missed what you were supposed to do for this issue.

  1. write this issue so that it has action items that achieve the scope listed in the overview

We need to research and recommend best practice so that we can audit the site to determine which quotes or lack of quotes need to be fixed.

The current draft of the action items, tell the person to make the changes, which is premature given that no one has done the research and recommendations yet. I am not asking you to do the research and recommendations, but rather write an issue for someone to do it.

Got it! Thank you Bonnie!

codyyjxn commented 2 weeks ago

@bonniewolfe Hi bonnie I have changed the instructions. I will attend todays meeting as well.