ER: Find all the places that Github should be GitHub and fix
- Dominant language
- JavaScript
- Stars
- 363
- Forks
- 872
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 18
Description
### 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
- #8390
- #8508
- 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](https://github.com/search?q=repo%3Ahackforla%2Fwebsite%20Github&type=code)
- 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]
Contributor guide
Assessment
This issue has not been assessed yet.