ER: issues on CONTRIBUTING PAGE

[garrettallen0]

Emergent Requirement - Problem

3 separate problems on CONTRIBUTING pages I list below.

1. Git GUI

On this page, on 2.7, the initial bullet point under the heading is incorrectly links to a "Create new page."

It is supposed to link to this site. Other versions of the CONTRIBUTING page do this correctly, but this version does not.

2. Handling SSH

On this page, on 2.7.f, step 4 reads like this:

Next you need to add your ssh key to your ssh agent.

ssh-add -K ~/.ssh/id_ed25519

But it doesn't say you need to use you own ssh agent, not "id_ed25519". This was a stumbling block to me as a new dev.

3. Duplication of delete instructions

On this page, under "3.1.b Complete pull request on Hack for LA website repo", the following reads like a duplication to me.

Once your pull request is merged you can delete your branch with the following command:

git branch -d update-give-link-2093

Now you can move on to your next issue and create a new branch. (This ensures you don’t accidentally include the changes from your previous branch in your new branch)

From here, once your pull request is approved and merged you can pull the recent merge from the Hack For LA repository and delete your local branch:

git pull upstream gh-pages
git branch -d update-give-link-2093

Issue you discovered this emergent requirement in

• my first issue, img Tag Refactor: Getting Started page - step-img-icon-git join-2.png #4394

Date discovered:

4/18/23

Did you have to do something temporarily

• NO

Who was involved

@garrettallen0

What happens if this is not addressed

Confusion to new developers.

Resources

Recommended Action Items

• Make a new issue
• Discuss with team
• Let a Team Lead know

Potential solutions

[garrettallen0]

Hi @jdingeman, could you give me feedback on this ER? Is it written intelligibly? Do I have the necessary labels? Anything I'm missing?

[ExperimentsInHonesty]

@garrettallen0 The ER is good, but not sure why it doesnt have the same formatting as other ERs. Did you copy from an existing ER instead of using the ER tempate?

Please fix the formatting. After that, I believe this ER is ready for 3 issues to get made from it. I have added the label ready for dev lead to it. But you are welcome to draft the 3 issues action items in the Potential solutions section.

[garrettallen0]

Thanks @ExperimentsInHonesty. No, I deleted the "###" the first time around simply because I didn't know I needed them! I think it is formatted correctly now.

[JessicaLucindaCheng]

1. Git GUI
   On this page, on 2.7, the initial bullet point under the heading is incorrectly links to a "Create new page."

It is supposed to link to this site. Other versions of the CONTRIBUTING page do this correctly, but this version does not.

The link (https://github.com/hackforla/website/blob/2e3c45fede99e61f479548ccca3f0dda83e351db/CONTRIBUTING.md#27-working-on-an-issue) is to a particular commit of the CONTRIBUTING.md file. If it works on the current file (https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md), then the problem has already been fixed, so an issue doesn't need to be written for that part of the ER.

[roslynwythe]

• Problem 1 Git GUI - has been resolved in the current version
• Problem 2 SSH
  • I agree that this can be clarified. https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md Update CONTRIBUTING.md Section 2.7.f i SSH for Mac #5693 (Mac) and Update CONTRIBUTING.md Section 2.7.f ii SSH for Windows #5694 (WIndows).
  • I suggest that if the ~/.ssh directory does not exist, it should be created prior to running ssh-keygen. Update CONTRIBUTING.md Section 2.7.f ii SSH for Windows - creating folder #5695 and #and Update CONTRIBUTING.md Section 2.7.f i SSH for Mac - creating folder #6240
• Problem 3 Duplication of delete instructions - Update CONTRIBUTING.md Section 3.1.b vi #5696

I would like to add:

• Problem 4 I suggest removing the statements regarding "pushing local commits to your repository" from Section 2.7.a Update CONTRIBUTING.md Section 2.7.a #5697
• Problem 5 - 2.7.b I suggest adding language to ensure that devs have checked out gh-pages before proceeding to create a new issue branch Update CONTRIBUTING.md Section2.7.b - making sure devs checkout gh-pages first #5698