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

[ExperimentsInHonesty]

Dependencies (Child Issues)

• replace Github with GitHub in website/redirections/github.md #7110
• replace Github with GitHub in communities-of-practice.html #7111
• Replace Github with GitHub in _data/navigation/social.yml #7112
• Replace Github with GitHub in _data/internal/communities/ui-ux.yml #7113
• Replace Github with GitHub in _data/internal/communities/engineering.yml #7115
• Replace Github with GitHub in _data/internal/communities/project-management.yml #7117
• Replace Github with GitHub in pages/getting-started.html #7118
• Replace Github with GitHub in _projects/ems-triage-tracker.md #7413
• Replace Github with GitHub in _projects/tech-work-experience.md #7414
• Replace Github with GitHub in _data/internal/communities/ops.yml #7415
• Replace Github with GitHub in _data/internal/communities/data-science.yml #7416
• Replace github with GitHub in github-actions/utils/post-issue-comment.js #7417
• Replace Github with GitHub in _guide-pages/2FA.html #7418
• Replace Github with GitHub in _sass/components/_guides.scss #7419
• Replace github with GitHub in _sass/components/_communities-of-practice.scss #7420
• Replace Github with GitHub in github-actions/trigger-issue/add-missing-labels-to-issues/add-labels-template.md #7421
• Replace Github with GitHub in assets/js/utility/api-events.js #7422
• Replace Github with GitHub in github-actions/trigger-schedule/list-inactive-members/get-contributors-data.js #7423
• Replace Github with GitHub in CONTRIBUTING.md Table of Contents 1.4.c #7438
• Replace Github with GitHub in CONTRIBUTING.md Section 1.4 #7439
• Replace github with GitHub in CONTRIBUTING.md Section 2.7.e #7440
• Replace github with GitHub in CONTRIBUTING.md Section 2.7.f i #7441
• Replace github with GitHub in CONTRIBUTING.md Section 2.7.f ii #7442
• Replace Github with GitHub in CONTRIBUTING.md Section 4.2.b #7443
• Replace Github with GitHub in assets/js/wins.js makecards #7494
• Replace Github with GitHub in assets/js/wins.js updateOverlay #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

• Update the GitHub resource name for the Access the Data Project #4685

Date discovered

2024-01-25

Did you have to do something temporarily

• YES
• 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

• website/github-actions/utils/format-comment.js

  Line 7 in 3c7c90e

  * @returns {String} - returns a formatted comment to be posted on github

• website/github-actions/utils/post-issue-comment.js

  Line 2 in 3c7c90e

  * Posts a comment on github

• website/github-actions/trigger-schedule/github-data/contributors-data.js

  Line 78 in 3c7c90e

  // Since Github only allows to fetch max 100 items per request, we need to 'flip' pages

• website/pages/wins/wins-share-form.html

  Line 464 in 3c7c90e

  //github photo permission

• website/_sass/components/_guides.scss

  Line 249 in 3c7c90e

  /* Populates an empty div for Users with no Github Link */

• website/assets/js/utility/api-events.js

  Line 36 in 3c7c90e

  // If a project doesn't have an hflaWebsiteUrl, redirect to the project's Github page

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

• website/redirections/github.md

  Line 4 in 3c7c90e

  title: Github

• website/pages/communities-of-practice.html

  Line 82 in 3c7c90e

  title="{{community[1].name}} Github Repo">

• website/_data/navigation/social.yml

  Line 31 in 3c7c90e

  - name: Github

• website/_data/internal/communities/ui-ux.yml

  Line 43 in 3c7c90e

  - name: Github

• website/_data/internal/communities/engineering.yml

  Line 38 in 3c7c90e

  - name: Github

• website/_data/internal/communities/project-management.yml

  Line 26 in 3c7c90e

  - name: Github

• website/_data/internal/toolkitresources.yml

  Line 13 in 3c7c90e

  - title: Github

Examples of locations it must be changed

• website/_guide-pages/github-issues.html

  Line 35 in 3c7c90e

  <h5>An effective Hack for LA Github issue includes the following components:</h5>

• website/pages/getting-started.html

  Line 101 in 3c7c90e

  <li class="g-s-list">Receive access to the Google Drive and Github repository by sending a Slack message of your Github username and Gmail address to a CoP lead. <img class="info-icon" src="assets/images/getting-started/information.png" alt="">

Recommended Action Items

• Make 2 issue templates in comments that will work for all the following types of changes, so that each issue is easy to make
• Review each potential change and decide if It's something that can be changed
  • 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
  • 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
• make issues - see Dependencies section above

Potential solutions [draft]

[daras-cu]

Hi @t-will-gillis,
I did go through all the files from the Resources section (here) and made a spreadsheet of the ones that I thought needed to be changed to keep track: Google Sheet

Thank you for going through the issues I created so far. I'll go ahead and make the issues for CONTRIBUTING.md and group whichever instances make sense into Complexity: Small issues. I'll wait for feedback on the other files in question.

That makes sense re: the good first issues, I have been separating them out so will continue to do so.

Thanks again for your help!

[ExperimentsInHonesty]

@daras-cu

For the purposes of discussion, I have added all the details we are looking at for the GitHub wins page and form to this comment.

wins.js

wins.js

Lines we intended to change below

website/assets/js/wins.js

Line 12 in a999c25

const github_url = "Github URL (optional)"

change

const github_url = "Github URL (optional)"

to

const github_url = "GitHub URL (optional)"

website/assets/js/wins.js

Line 13 in a999c25

const github_permission = "Could we use your Github profile picture next to your story?"

change

const github_permission = "Could we use your Github profile picture next to your story?"

to

const github_permission = "Could we use your GitHub profile picture next to your story?"

https://github.com/hackforla/website/blob/a999c255a87d761e7579db1d76a6e0a0a3a05d39/assets/js/wins.js#L28C1-L28C74
change

		"I increased the number of commits on my Github profile": `github.svg`,

to

		"I increased the number of commits on my GitHub profile": `github.svg`,

website/assets/js/wins.js

Line 334 in a999c25

cloneCardTemplate.querySelector('.github-icon').alt = `Github profile for ${card[name]}`;

change

			cloneCardTemplate.querySelector('.github-icon').alt = `Github profile for ${card[name]}`;

to

			cloneCardTemplate.querySelector('.github-icon').alt = `GitHub profile for ${card[name]}`;

website/assets/js/wins.js

Line 509 in a999c25

makeIcon(data[i][github_url], overlayIcons, 'github-icon', '/assets/images/wins-page/icon-github-small.svg', 'Github profile for ' + data[i][name]);

change

  			makeIcon(data[i][github_url], overlayIcons, 'github-icon', '/assets/images/wins-page/icon-github-small.svg', 'Github profile for ' + data[i][name]);

to

  			makeIcon(data[i][github_url], overlayIcons, 'github-icon', '/assets/images/wins-page/icon-github-small.svg', 'GitHub profile for ' + data[i][name]);

Code.js

Any changes in this file (code.js) will have to also be made in the Google App Script attached to the spreadsheet

Lines we intended to change below

website/google-apps-scripts/wins-form-responses/Code.js

Line 147 in 50af246

processedFormDataObject.set("GitHub", rawFormDataObject["Github URL (optional)"])

Change

  processedFormDataObject.set("GitHub", rawFormDataObject["Github URL (optional)"])

to

  processedFormDataObject.set("GitHub", rawFormDataObject["GitHub URL (optional)"])

website/google-apps-scripts/wins-form-responses/Code.js

Line 148 in 50af246

processedFormDataObject.set("GitHub Picture Allowed ?", rawFormDataObject["Could we use your Github profile picture next to your story?"])

Change

  processedFormDataObject.set("GitHub Picture Allowed ?", rawFormDataObject["Could we use your Github profile picture next to your story?"])

to

  processedFormDataObject.set("GitHub Picture Allowed ?", rawFormDataObject["Could we use your GitHub profile picture next to your story?"])

Comparison

First correlation

website/google-apps-scripts/wins-form-responses/Code.js

Line 147 in 50af246

processedFormDataObject.set("GitHub", rawFormDataObject["Github URL (optional)"])

seems related to line 12 in the wins.js file

website/assets/js/wins.js

Line 12 in a999c25

const github_url = "Github URL (optional)"

Second correlation

website/google-apps-scripts/wins-form-responses/Code.js

Line 148 in 50af246

processedFormDataObject.set("GitHub Picture Allowed ?", rawFormDataObject["Could we use your Github profile picture next to your story?"])

seems related to line 13 in the wins.js file

website/assets/js/wins.js

Line 13 in a999c25

const github_permission = "Could we use your Github profile picture next to your story?"

Form headers (from the spreadsheet)

All columns that correspond to the questions

• Email Address
• Full name
• Linkedin URL (optional)
• Could we use your Linkedin profile picture next to your story?
• Github URL (optional)
• Could we use your Github profile picture next to your story?
• Select the team(s) you're on
• Select your role(s) on the team
• What is/was your specific role? (optional)
• When did you join Hack for LA? (optional)
• What do you want to celebrate (select all that apply)?
• Give us a brief overview

Additional form headers in addition to the form questions

Timestamp
Display?
Homepage?

Form Question Changes

Change form question from ``` Could we use your Github profile picture next to your story? ``` to ``` Could we use your GitHub profile picture next to your story? ```

Does the above seem to cover it all (excluding pages/wins/wins-share-form.html for now)? And if it does cover everything, what is your question.

[daras-cu]

@ExperimentsInHonesty
Thank you for the clarification on issue size/role labels, that all makes sense.

Re: wins.js and Code.js I believe that does cover all the instances that need to be corrected in those files. My main question is for the lines with correlations to the Google form, how should I handle changing the questions on the form when updating the JS files so the question names remain in sync? (I do not have permission to view the spreadsheet you linked and assume other volunteers do not either)

If I create an issue for each form question that needs to be changed, the action items could be to edit the corresponding lines in both Code.js and wins.js, and update the question in the Google form. The assignee would have to be someone who has permissions for the form already, or would have to request permissions as part of working on the issue.

Alternatively, the issue could cover editing just Code.js and wins.js and then require a note to be left on the PR that the issue should only be merged by someone who can update the question on the Google form at the same time.

I'm also not sure about how testing would work for these issues. It appears that _data/external/_wins-data.json would have to be updated to reflect the new question names in order for wins.js to populate the Wins webpage correctly. It looks like _wins-data.json is updated by a bot account rewriting the file in its own branch then opening a PR (the code for this is in the main function in Code.js), which I'm not sure can be replicated in someone's forked repository. The issues I create could just call for the edits to the files without testing. Regardless, once the edited files are merged I think the _wins-data.json file will have to be updated immediately for the Wins webpage to display correctly, as otherwise the JSON data will still have the old question names as keys. Can we manually trigger an update after the changes are merged? If so how should I document that this needs to be done in the issues?

I hope all that is clear and that I'm understanding how the files work together correctly.

[daras-cu]

Update:
I created issues #7494 and #7495 to fix two 'Github' instances in wins.js that are independent from the Wins form.

I have been familiarizing myself with the Google Apps Script development process and am working on getting access to the necessary Google docs to see how and where to make changes to the Wins form questions that include 'Github' and are referenced in Code.js and wins.js.

[daras-cu]

Update:
The remaining issues to create for this ER involve making changes to the Wins form. As discussed with @roslynwythe, we should improve the documentation on Wins form development and testing before asking developers to work on these issues. I'll be going through the setup process for Wins issues locally and will note any areas where documentation can be improved. This will also help me better understand how to write the issues for this ER when we are ready for them.