Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaced 'Github' with 'GitHub' in tech-work-experience.md #7589

Conversation

pluto-bell
Copy link
Member

Fixes #7414

What changes did you make?

  • Replaced - name: Github with - name: GitHub in _projects/tech-work-experience.md

Why did you make the changes (we will use this info to test)?

  • To fix display issues stemming from name: variable

Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)

Visuals before changes are applied Screenshot 2024-10-13 at 5 10 56 PM Screenshot 2024-10-13 at 5 11 07 PM
Visuals after changes are applied Screenshot 2024-10-13 at 5 10 43 PM Screenshot 2024-10-13 at 5 11 15 PM

Connected Files

The _projects/tech-work-experience.md is referenced by _layouts/project.html which dynamically creates each project card.
The _projects/tech-work-experience.md file is also referenced by current-projects.js which dynamically creates a display card for each project.

Test Procedure

Follow How to review Pull Requests in order to clone the feature branch

Copy link

Want to review this pull request? Take a look at this documentation for a step by step guide!


From your project repository, check out a new branch and test the changes.

git checkout -b pluto-bell-pluto/replace_Github_with_GitHub_issue7414 gh-pages
git pull https://github.com/pluto-bell/hack4la.git pluto/replace_Github_with_GitHub_issue7414

@github-actions github-actions bot added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Complexity: Medium P-Feature: Project Info and Page A project's detail page (e.g. https://www.hackforla.org/projects/100-automations) Status: Updated No blockers and update is ready for review size: 1pt Can be done in 4-6 hours labels Oct 14, 2024
@8alpreet 8alpreet self-requested a review October 15, 2024 03:11
@8alpreet
Copy link
Member

8alpreet commented Oct 15, 2024

ETA: EOD Oct 16
Availability: 3pm - 7pm, Mon - Fri

@k-cardon k-cardon self-requested a review October 15, 2024 04:56
Copy link
Member

@codyyjxn codyyjxn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @pluto-bell,
Thank you for taking the time to work on this issue!

Things that went well:

  • The issue was correctly linked.
  • The right file was modified.
  • You applied the necessary labels.
  • Including the before-and-after screenshots was very helpful, making it easy for others to review the changes.

Areas for improvement:

  • The branch name could be updated. There's no need to include "pluto" twice. A better option would be replace_Github_with_GitHub-7414.

Please feel free to reach out if you have any questions or need further clarification. Thanks again for your valuable contribution!

@daras-cu
Copy link
Member

@codyyjxn thanks for your review! The branch name may be a little redundant but there is no way to change it without closing this pull request and opening a new one, and the guidelines about branch names are more suggestions than hard and fast rules. If everything else looks good let's approve this PR as is and @pluto-bell can keep your feedback in mind for future issues.

@k-cardon please leave a comment with your availability and ETA if you are still planning to review this issue.

@k-cardon
Copy link
Member

ETA: EOD Oct 17
Availability: evenings, weekends

@pluto-bell
Copy link
Member Author

pluto-bell commented Oct 16, 2024

@codyyjxn I see, I didn't realize it was configured to automatically add my user name, on my end the branch was just: pluto/...

Now I know it'll be taken care of for me (:, thanks for the point out.

Copy link
Member

@k-cardon k-cardon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks correct here! Code is changed correctly, text shows up properly on the development server on both pages, pull request is detailed yet concise. Thanks!

@codyyjxn
Copy link
Member

@codyyjxn I see, I didn't realize it was configured to automatically add my user name, on my end the branch was just: pluto/...

Now I know it'll be taken care of for me (:, thanks for the point out.

No Problem. Please request a review so I can approve this tonight.

Copy link
Member

@8alpreet 8alpreet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @pluto-bell,

Great job on this issue! Tracking down the right files in this project can be difficult but you found the right files that use this variable. I tested your changed locally and it looks good! Both the project card in the projects page and the project specific page now display GitHub.

Things you did well:

  • PR title is informative and concise
  • comment includes "Fixes..."
  • What section is answered well
  • Screenshots clearly show the change
  • You correctly identified the connected files
  • You changed only the appropriate line of code

What could be improved:

  1. Why section: the why section is not entirely accurate. This change isn't due to display issues, rather it's to unify the presentation of the name "GitHub" across the website. We don't want to display "Github" which is not how the company spells their name.
  2. File name mentions: it would be nice to have full path assets/js/current-projects.js instead of current-projects.js. This is not a big deal, but we have many directories and it can be hard to find files so having the full path makes things easier.
  3. The branch naming has already been addressed. However, a small clarification is necessary. Your name is not being added to the branch, your GitHub handle is being displayed as the source of the branch. For example, it says "commit into hackforla:gh-pages" to inform us that the commit will be merged into gh-pages which belongs to the "hackforla" organization's GitHub handle.

@8alpreet
Copy link
Member

@pluto-bell, @codyyjxn

I would like to mention something which Bonnie mentioned at yesterday's (Oct 15) dev meeting. When someone doesn't name the branch correctly, we don't need to have them rename the branch and make a new PR. We can leave feedback and they can do better next time.

It looks like you too are already on board with this idea, but I thought I would mention it just to be safe.

@pluto-bell, I already re-requested a review form @codyyjxn. However, I think the old "requested changes" needs to be dismissed. I could do it for you, but I thought it best to leave it to you.

@t-will-gillis t-will-gillis merged commit 1f1f0ae into hackforla:gh-pages Oct 19, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium P-Feature: Project Info and Page A project's detail page (e.g. https://www.hackforla.org/projects/100-automations) role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours Status: Updated No blockers and update is ready for review
Projects
Development

Successfully merging this pull request may close these issues.

Replace Github with GitHub in _projects/tech-work-experience.md
6 participants