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

Update CONTRIBUTING.md Section 2.7.f ii SSH for Windows #5694

Closed
4 tasks done
roslynwythe opened this issue Oct 10, 2023 · 2 comments · Fixed by #5974
Closed
4 tasks done

Update CONTRIBUTING.md Section 2.7.f ii SSH for Windows #5694

roslynwythe opened this issue Oct 10, 2023 · 2 comments · Fixed by #5974
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.25pt Can be done in 0.5 to 1.5 hours

Comments

@roslynwythe
Copy link
Member

roslynwythe commented Oct 10, 2023

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

In CONTRIBUTING - 2.7.f ii "Setting up SSH keys for Windows" we need to clarify the instructions in order to avoid confusion.

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md Section 2.7.f i "Setting up SSH Keys for Windows"
  • Replace
4. Next you need to add your ssh key to your ssh agent.

with

4. Next you need to add your ssh key to your ssh agent.  In the command below, replace `id_ed25519` with the filename (without file extension) you provided in the previous step.
  • 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

CONTRIBUTING - 2.7.f ii "Setting up SSH keys for Windows"
Getting started with writing and formatting on GitHub

@roslynwythe roslynwythe 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 good first issue Good for newcomers labels Oct 10, 2023
@github-actions github-actions bot removed the good first issue Good for newcomers label Oct 10, 2023
@roslynwythe roslynwythe added good first issue Good for newcomers size: 0.25pt Can be done in 0.5 to 1.5 hours and removed size: 0.5pt Can be done in 3 hours or less labels Oct 10, 2023
@roslynwythe roslynwythe removed the good first issue Good for newcomers label Oct 23, 2023
@ExperimentsInHonesty ExperimentsInHonesty added this to the 08. Team workflow milestone Nov 6, 2023
@jleung7158 jleung7158 self-assigned this Nov 27, 2023
Copy link

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

@jleung7158
Copy link
Member

i. Availability: M-T after 2PM, W-F after 7PM
ii. ETA: 1 week!

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.25pt Can be done in 0.5 to 1.5 hours
Projects
Development

Successfully merging a pull request may close this issue.

3 participants