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

Refactor CONTRIBUTING.md: Removes slash at closure of Image Tag in Section 2.4 #7522

Conversation

mSharifHub
Copy link
Contributor

@mSharifHub mSharifHub commented Sep 25, 2024

Fixes #7097

What changes did you make?

-Root Directory CONTRIBUTING.md file refactored by removing slash at end of closure image tag on Section 2.4
make it better

For Reviewers: Do not test changes locally, rather test changes at https://github.com/mSharifHub/website/tree/img-tag-refactor-contributing.md-sec.2.4.b-%237097/CONTRIBUTING.md

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

-As requested in the Issue to meet the same syntax format of other tags

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

-No visual changes to the website

@mSharifHub mSharifHub requested review from t-will-gillis and abuna1985 and removed request for t-will-gillis September 25, 2024 06:20
Copy link

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


Note that CONTRIBUTING.md cannot previewed locally; rather it should be previewed at this URL:

https://github.com/mSharifHub/website/blob/img-tag-refactor-contributing.md-sec.2.4.b-#7097/CONTRIBUTING.md  

@github-actions github-actions bot added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Feature: Wiki Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Refactor HTML size: 0.5pt Can be done in 3 hours or less labels Sep 25, 2024
@k-cardon k-cardon self-requested a review September 25, 2024 17:27
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.

Code and branch look correct, and the PR is clear. One change needed--the link to the correct page to confirm no visual changes is broken--when I click the link you provided, it returns 404 not found.

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.

Thank you for taking on this issue @mSharifHub
Things that went well:
-You made the correct branch name.

  • The change on the file is correct.

Somethings you need to complete is:

  • You need to check the boxes from the original issue.
  • You also need to provide the link as the issue prompted you to do.
  • I don't see a URL where I can go to see what changes you made.

@mSharifHub
Copy link
Contributor Author

Hey, I just noticed the feedback. I will do the above, however, there is no visual changes. The original issue is asking to remove the slash at ending index. This is not visible to the end user rather just a syntax style change.

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.

The issue persists--this link is broken:

https://github.com/mSharifHub/website/tree/img-tag-refactor-contributing.md-sec.2.4.b-#7097/CONTRIBUTING.md

correct link is needed to the contributing page so we can verify no visual changes. Maybe a reread of the issue would help? Or just a working link to the relevant section of the contributing page? (I was a bit confused by the issue directions as well)

@mSharifHub
Copy link
Contributor Author

@mSharifHub
Copy link
Contributor Author

Yah, I dont know why the link is broken,

@mSharifHub
Copy link
Contributor Author

I sent a message on slack. I followed all instructions yet I dont know why the link is broken. Im sorry, I only have been with Hack For LA for a short period. I will be waiting for someone to help resolve the broken link.

@ajb176 ajb176 self-requested a review September 26, 2024 15:26
Copy link
Member

@ajb176 ajb176 left a comment

Choose a reason for hiding this comment

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

Hi @mSharifHub

It looks like you've tried to guess the URL based on the example URL Roslyn provided, that isn't working because your branch URL has the character '#' that needs to be escaped.

You just need to manually navigate to the branch in your local repo where you've made the changes, click on the contributing.md file in that branch, and link the URL you get.

@mSharifHub
Copy link
Contributor Author

You totaly right, the "#" needs to be escaped. I should had named differently . I updated with %23

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.

Well Done ! @mSharifHub

@ajb176 ajb176 removed the request for review from abuna1985 September 27, 2024 06:34
Copy link
Member

@ajb176 ajb176 left a comment

Choose a reason for hiding this comment

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

Looks good, nice work. A few notes for next time:

  • You can easily just get the link by clicking on mSharifHub:img-tag-refactor-contributing.md-sec.2.4.b-#7097 above the PR, then scrolling down and clicking on the contributing.md file. Although just escaping the '#' works, it's easy to just navigate to where the file is located on your fork and copy/paste the URL there.
  • Unless you have a reason to, it's best not to request review from specific reviewers. They may be busy or may not be active, which could delay the PR from being reviewed.
  • Your branch name is very detailed which is great, but something like
    img-tag-refactor-contributing-7097 is also good enough if you'd rather keep it simpler. It doesn't matter too much but as you've seen, using some characters like '#' can make things a little more complicated.

Anyway, nice work on the issue.

@mSharifHub
Copy link
Contributor Author

Hello,

Yes the branch should be kept detail but simple. Thanks for the feedback and approving it.

@terrencejihoonjung
Copy link
Member

eta: today, 11:59pm PST
availability: 5pm - 9pm PST, Mon-Fri

Copy link
Member

@terrencejihoonjung terrencejihoonjung left a comment

Choose a reason for hiding this comment

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

Hi @mSharifHub,

  • changes made and why they were made stated clearly
  • concise, clear PR title
  • branching is correct
  • changes are correct in preview link

Well done! Thank you for your contribution :)

@daras-cu daras-cu dismissed k-cardon’s stale review October 1, 2024 01:02

Link was corrected

@daras-cu daras-cu merged commit a19d41b into hackforla:gh-pages Oct 1, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Refactor HTML Feature: Wiki role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less
Projects
Development

Successfully merging this pull request may close these issues.

img tag refactor in CONTRIBUTING.md Sec 2.4.b
6 participants