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 i SSH for Mac #5693

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

Update CONTRIBUTING.md Section 2.7.f i SSH for Mac #5693

roslynwythe opened this issue Oct 10, 2023 · 5 comments · Fixed by #5941
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

@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 "i. Setting up SSH keys for Mac" we need to clarify the instructions used for setting up an SSH key for Mac in Section 2.7.f i in order to avoid confusion.

Action Items

  • In your local IDE, open CONTRIBUTING.md and navigate to Section 2.7.f i "Setting up SSH Keys for Mac"
  • 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 "i. Setting up SSH keys for Mac"
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 size: 0.25pt Can be done in 0.5 to 1.5 hours and removed role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers labels Oct 10, 2023
@roslynwythe roslynwythe changed the title Update CONTRIBUTING.md Section 2.7.f i Update CONTRIBUTING.md Section 2.7.f i SSH for Mac Oct 10, 2023
@roslynwythe roslynwythe removed the size: 0.25pt Can be done in 0.5 to 1.5 hours label Oct 23, 2023
@ExperimentsInHonesty ExperimentsInHonesty removed the good first issue Good for newcomers label Oct 29, 2023
@ExperimentsInHonesty ExperimentsInHonesty added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers and removed role missing labels Nov 6, 2023
@ChrisKildunne ChrisKildunne self-assigned this Nov 16, 2023
Copy link

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

@ChrisKildunne
Copy link
Member

Availability: Weekday Evenings
ETA: Just made the PR should be done by end of day :)

@ChrisKildunne
Copy link
Member

Progress: I have made the changes to the contributing.md
Blockers: I am continuously running into formattiong issues every *** gets switched to --- in my remote branch. I have disabled extentions and toggled of format on save in vs code. Due to this I believe I am running into merge conflicts.
Availability: I have about an hour every evening to work on this.

@ajb176
Copy link
Member

ajb176 commented Nov 21, 2023

I'm just guessing here, but you may need to restart VS Code or your computer.

Try restarting your computer after double checking to make sure you've disabled all the extensions. Then pull from upstream and open the file in a text editor like notepad (to see if the files match the upstream files). If you don't see the issue in a different editor, at least you know it's a VSCode issue and not an issue updating the local repository.

If you open the file in VSCode and you're still seeing the edits, I can suggest re-installing but if you don't want to do that you'll probably have to do some googling.

@ajb176
Copy link
Member

ajb176 commented Nov 21, 2023

If all else fails, you can just use a different editor to edit the file and figure things out with VSCode later

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
4 participants