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

Replace github with GitHub in CONTRIBUTING.md Section 2.7.f ii #7442

Closed
8 of 9 tasks
daras-cu opened this issue Sep 12, 2024 · 3 comments · Fixed by #7558
Closed
8 of 9 tasks

Replace github with GitHub in CONTRIBUTING.md Section 2.7.f ii #7442

daras-cu opened this issue Sep 12, 2024 · 3 comments · Fixed by #7558
Assignees
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Onboarding/Contributing.md 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

@daras-cu
Copy link
Member

daras-cu commented Sep 12, 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

We need to replace instances of Github and github with GitHub so that we display the company name correctly.

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md
    In section 2.7.f ii:
  • Replace
1. You have to set up SSH keys in order to contribute to github remotely. First check if you have any keys set up already. Open Git Bash and run:

with

1. You have to set up SSH keys in order to contribute to GitHub remotely. First check if you have any keys set up already. Open Git Bash and run:
  • Replace
2. Then enter the text below into your terminal using your github account email address.

with

2. Then enter the text below into your terminal using your GitHub account email address.
  • Replace
5. Finally copy the ssh key to add it to your github account by entering the following command. This copies the contents of the id_ed25519.pub file to your clipboard __Don't copy anything else until after you finish the last step, or else you will have to repeat this step.__

with

5. Finally copy the ssh key to add it to your GitHub account by entering the following command. This copies the contents of the id_ed25519.pub file to your clipboard __Don't copy anything else until after you finish the last step, or else you will have to repeat this step.__
  • Replace
6. Go to your github accounts ssh key settings, and click on the button that says _New SSH key_. In the "Title" field, add a descriptive label for the new key. Paste the key into the form that pops up. Click Add SSH Key

with

6. Go to your GitHub account's ssh key settings, and click on the button that says _New SSH key_. In the "Title" field, add a descriptive label for the new key. Paste the key into the form that pops up. Click Add SSH Key

  • 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

Merge Team

@daras-cu daras-cu 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 labels Sep 12, 2024
@daras-cu daras-cu moved this to New Issue Approval in P: HfLA Website: Project Board Sep 12, 2024
@daras-cu daras-cu added the ready for dev lead Issues that tech leads or merge team members need to follow up on label Sep 12, 2024
@ExperimentsInHonesty ExperimentsInHonesty removed the ready for dev lead Issues that tech leads or merge team members need to follow up on label Sep 14, 2024
@izma-mujeeb izma-mujeeb self-assigned this Sep 23, 2024
@izma-mujeeb izma-mujeeb moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Sep 23, 2024
@HackforLABot

This comment was marked as outdated.

@HackforLABot HackforLABot moved this from In progress (actively working) to New Issue Approval in P: HfLA Website: Project Board Sep 23, 2024
@jenjenkayi jenjenkayi self-assigned this Oct 1, 2024
@jenjenkayi jenjenkayi moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Oct 1, 2024
@HackforLABot
Copy link
Contributor

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

@jenjenkayi
Copy link
Member

i. Availability: 10/2 1pm-3pm
ii. ETA: 10/2 by 3pm

@github-project-automation github-project-automation bot moved this from In progress (actively working) to QA in P: HfLA Website: Project Board Oct 8, 2024
@kgold2018 kgold2018 moved this from QA to Done in P: HfLA Website: Project Board Nov 9, 2024
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: Onboarding/Contributing.md 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.

5 participants