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

Fix broken image in CONTRIBUTING.md Section 2.7.d #6582

Closed
5 tasks done
danvgar opened this issue Apr 6, 2024 · 3 comments · Fixed by moazDev1/website#1 or #6690
Closed
5 tasks done

Fix broken image in CONTRIBUTING.md Section 2.7.d #6582

danvgar opened this issue Apr 6, 2024 · 3 comments · Fixed by moazDev1/website#1 or #6690
Assignees
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue 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

Comments

@danvgar
Copy link
Member

danvgar commented Apr 6, 2024

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

The readability and accuracy of our CONTRIBUTING.md documentation is crucial for ensuring a smooth onboarding process for new members. The current documentation in Section 2.7d contains a broken image that needs to be fixed.

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md
  • Replace
You can also sync your fork directly on GitHub by clicking "Sync Fork" at the right of the screen and then clicking "Update Branch"

<details>
  <summary><strong>Click here</strong> to see how to sync the fork on GitHub</summary>
  <img src="https://github-production-user-asset-6210df.s3.amazonaws.com/5314153/307199130-f50cd9c2-a37c-432f-9745-df8325fd581a.png" />
</details>

with

You can also sync your fork directly on GitHub by clicking "Sync Fork" at the right of the screen and then clicking "Update Branch"

<details>
  <summary><strong>Click here</strong> to see how to sync the fork on GitHub</summary>
  <img src="https://raw.githubusercontent.com/wiki/hackforla/website/images/how-to-review-pull-requests/step3-sync-demo.gif" />
</details>
  • With CONTRIBUTING.md still open, make a note of the section in which the replaced content appears, so that you will know where to look in the document to preview the change.
  • Changes to CONTRIBUTING.md cannot be tested locally, rather they must be tested after pushing the issue branch to your fork of the repository. Push your issue branch in the usual manner, but before creating the Pull Request, check your updates using this test URL. Also store the test URL for use in a later step:
https://github.com/[REPLACE WITH GITHUB HANDLE]/website/blob/[REPLACE WITH NAME OF ISSUE BRANCH]/CONTRIBUTING.md

(for example: https://github.com/bonniewolfe/website/blob/issue-branch-1234/CONTRIBUTING.md)

  • Create a pull request with your changes. In the Pull Request, after the "Why did you make the changes" section, add this line to help reviewers, replacing the text in brackets (and the brackets) with the test URL from the previous Action Item.
For Reviewers: Do not review changes locally, rather, review changes at [REPLACE WITH TEST URL]

Resources/Instructions

@danvgar danvgar 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 size: 0.5pt Can be done in 3 hours or less Draft Issue is still in the process of being created labels Apr 6, 2024
@danvgar danvgar added this to New Issue Approval in Project Board via automation Apr 6, 2024
@danvgar danvgar moved this from New Issue Approval to In progress (actively working) in Project Board Apr 6, 2024
@danvgar

This comment was marked as resolved.

@danvgar danvgar changed the title [DRAFT] Fix broken image in CONTRIBUTING.md Section 2.7.d Fix broken image in CONTRIBUTING.md Section 2.7.d Apr 6, 2024
@danvgar danvgar removed the Draft Issue is still in the process of being created label Apr 6, 2024
@ExperimentsInHonesty ExperimentsInHonesty moved this from In progress (actively working) to Prioritized backlog in Project Board Apr 17, 2024
@moazDev1 moazDev1 self-assigned this Apr 20, 2024
@moazDev1 moazDev1 moved this from Prioritized backlog to In progress (actively working) in Project Board Apr 20, 2024
Copy link

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

@moazDev1
Copy link
Member

Availability: Sat-Mon (6PM - 10PM)
ETA: By tomorrow

moazDev1 pushed a commit to moazDev1/website that referenced this issue Apr 20, 2024
Project Board automation moved this from In progress (actively working) to QA Apr 20, 2024
jphamtv pushed a commit that referenced this issue Apr 25, 2024
Co-authored-by: Moaz Ali <moaaz98@users.noreply.github.com>
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: 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 a pull request may close this issue.

3 participants