ER: Find all the places that GitHub should be GitHub and fix

[ExperimentsInHonesty]

Dependencies (Child Issues)

• #7110
• #7111
• #7112
• #7113
• #7115
• #7117
• #7118
• #7413
• #7414
• #7415
• #7416
• #7417
• #7418
• #7419
• #7420
• #7421
• #7422
• #7423
• #7438
• #7439
• #7440
• #7441
• #7442
• #7443
• #7494
• #7495
• To do: Issues for Code.js and wins.js, which are linked to the Wins Form

Emergent Requirement - Problem

GitHub is a company name and should only be in lowercase (github) when in a URL, variable or directory name (where the variables or directories are all lowercase).

Details

There are 180 files with some form of github in it.

Issue you discovered this emergent requirement in

• #4685

Date discovered

2024-01-25

Did you have to do something temporarily

• [ ] YES
• [x] NO

Who was involved

@ExperimentsInHonesty

What happens if this is not addressed

• If it's public facing, it's unprofessional not to fix it.
• if it's in our non-public facing code, it's best practices to use it consistently as intended

Resources

• 180 files in our repo with some form of the name github in it
  • I reviewed all the instances, and divided them up into could, be careful, and must.

Examples of locations that could be changed

• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/github-actions/utils/format-comment.js#L7
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/github-actions/utils/post-issue-comment.js#L2
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/github-actions/trigger-schedule/github-data/contributors-data.js#L78
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/pages/wins/wins-share-form.html#L464
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/_sass/components/_guides.scss#L249
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/assets/js/utility/api-events.js#L36

Example of locations that could be changed, but it might break some logic.

• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/redirections/github.md?plain=1#L4
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/pages/communities-of-practice.html#L82
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/_data/navigation/social.yml#L31
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/_data/internal/communities/ui-ux.yml#L43
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/_data/internal/communities/engineering.yml#L38
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/_data/internal/communities/project-management.yml#L26
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/_data/internal/toolkitresources.yml#L13

Examples of locations it must be changed

• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/_guide-pages/github-issues.html#L35
• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/pages/getting-started.html#L101

Recommended Action Items

• [x] Make 2 issue templates in comments that will work for all the following types of changes, so that each issue is easy to make
• [x] Review each potential change and decide if It's something that can be changed
  • [x] without risk, in which case it's a good first issue
    • Examples of locations that could be changed
    • Examples of locations it must be changed
  • [x] might have risk and will need to be tested, in case it's a medium issue and will need to specify that the assignee will have to devise and document what tests they intend to do, so that when the PR is reviewed, the merge team can sign off that the change was tested adequately.
    • Example of locations that could be changed, but it might break some logic.
• [ ] move this issue to the questions column and add the ready for merge team label with the following note in a comment
• [x] make issues - see Dependencies section above

Potential solutions [draft]

[alexgklein]

Hi! I'm a student from the University of Florida looking to make a first-time contribution for an assignment. Mind if I take a shot at this issue?

[ExperimentsInHonesty]

@a1exanderklein if you are interested in joining the org (free) and working on issues, please signup for onboarding https://www.hackforla.org/getting-started

[github-actions[bot]]

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

[SteeRevo]

Availability: Weekends 3pm-12pm ETA: This upcoming Sunday night at earliest, at latest 3/10/2024

[SteeRevo]

Hi @ExperimentsInHonesty, do you still happen to have the list of instances to change? If not that's totally OK.

[SteeRevo]

Provide Update

1. Progress: Completed updating all comments and some titles
2. Blockers: Still sorting through which GitHubs need to be updated
3. Availability: 3pm-12pm
4. ETA: 3/10/24

[github-actions[bot]]

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

[roslynwythe]

Template for updates without risk (good first issues), for example: https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/_sass/components/_guides.scss#L249

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 need to replace instances of Github and github with GitHub so that we display the company name correctly.

Action Items

• [ ] Open [FILE PATH] in your IDE
• [ ] Change

[INSERT LINE OF CURRENT CODE HERE]

to

[INSERT DESIRED LINE OF CODE HERE]

• [ ] Add/commit changes then create Pull Request as usual

Resources

• This issue resulted from #6161

Merge Team

• [ ] After closing this issue, check off the dependency in #6161. If all dependecies have been completed, close #6161

[roslynwythe]

Template for updates with some risk, for example

• https://github.com/hackforla/website/blob/3c7c90e384563e35f5535a2784e1bca8b9cd2639/redirections/github.md?plain=1#L4

Overview

We need to replace instances of Github and github with GitHub so that we display the company name correctly, and test the changes to ensure the behavior and appearance of any and all related webpages are unchanged.

Action Items

• [ ] Open [FILE PATH] in your IDE
• [ ] Change

[INSERT LINE OF CURRENT CODE HERE]

to

[INSERT DESIRED LINE OF CODE HERE]

• [ ] Find all the files that are connected to this change. (e.g., if its a yml or md file, what files or scripts use the data stored in that file). And document briefly how they work together.
• [ ] Define where you expect the change to show up on the website (e.g., the footer of the website). Can be on multiple pages
• [ ] Write a test procedure, in a comment, and then use it to test the change. Include a link to this comment in your PR.
• [ ] Add/commit changes then create a PR as usual. Document the test procedure in the Pull Request.

Resources

• This issue resulted from #6161

Merge Team

• [ ] After closing this issue, check off the dependency in #6161. If all dependecies have been completed, close #6161

[roslynwythe]

@ExperimentsInHonesty please review both templates (above)

[ExperimentsInHonesty]

Replace this text

Devise, document and execute a test procedure to ensure that the behavior and appearance of all related webpages are unchanged.

with this

- [ ] Find all the files that are connected to this change.  (e.g., if its a yml or md file, what files or scripts use the data stored in that file).  And document briefly how they work together.
- [ ] Define where you expect the change to show up on the website (e.g., the footer of the website).  Can be on multiple pages
- [ ] Write a test procedure, in a comment, and then use it to test the change.  Include a link to this comment in your PR.