ER: Clarify step 2.7.d in CONTRIBUTING.md

[DrAcula27]

trafficstars

Emergent Requirement - Problem

When following the instructions in CONTRIBUTING.md, step 2.7.d is ambiguous. This step needs to be clarified.

Issue you discovered this emergent requirement in

• #6179

Date discovered

April 17, 2024

Did you have to do something temporarily

• [ ] YES
• [x] NO

Who was involved

@elliot-d-kim @LRenDO

What happens if this is not addressed

If not addressed, other contributors might also get confused with the instructions here. This will slow down workflows by:

• causing them to have to stop what they are doing to ask for help,
• take time from others to answer the question, and
• potentially have this same question asked repeatedly.

Resources

• CONTRIBUTING.md

Recommended Action Items

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

Potential solutions [draft]

Because there is another issue that also addresses this portion of CONTRIBUTING.md, this ER is dependent on it. When creating the issue for this ER, use the issue template "Blank Issue Form with Dependency" and make sure it is dependent on:

• https://github.com/hackforla/website/issues/6581

Once the dependent issue is completed, I recommend the following:

Replace:

#### **2.7.d Working on an issue (4): Pulling from upstream before you push**

**IMPORTANT:** Before you push your local commits to your repository, sync your fork to the main Hack For LA website repository. `git pull upstream` will ensure that your local repository is up-to-date with the main site:

    ```bash
    git pull upstream gh-pages
    ```

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:

#### **2.7.d Working on an issue (4): Pulling from upstream before you push**

**IMPORTANT:** Before you push your local commits to your repository, sync your fork to the main Hack For LA website repository. You can 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>

Next, bring upstream changes into your topic branch. With your topic branch checked out, run: 

    ```bash
    git pull upstream gh-pages
    ```

[elliot-d-kim]

I think this ER looks good to me, including the proposed changes! Thanks for looping me in :)

[roslynwythe]

Thank you @DrAcula27 for raising some good points. I also found it confusing how the instructions in 2.7.d start by mentioning sync of the fork, then they mention the git pull, then they return to sync of the fork. To resolve that confusion, I would like to suggest the following:

Replace:

2.7.d Working on an issue (4): Pulling from upstream before you push

IMPORTANT: Before you push your local commits to your repository, sync your fork to the main Hack For LA website repository. git pull upstream will ensure that your local repository is up-to-date with the main site:

git pull upstream

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

Click here to see how to sync the fork on GitHub

with:

2.7.d Working on an issue (4): Pulling from upstream before you push

IMPORTANT: Before you push your local commits to your repository, sync your fork to the main Hack For LA website repository. You can sync your fork directly on GitHub by clicking "Sync Fork" at the right of the screen and then clicking "Update Branch"

Click here to see how to sync the fork on GitHub

Next bring upstream changes into your topic branch. With your topic branch checked out, run

git pull upstream gh-pages

How does that look to you?

[DrAcula27]

@roslynwythe I like that! Your version of the revision makes it more clear, I think.

Should I go ahead with creating the issue using your revision?

[github-actions[bot]]

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

[DrAcula27]

Availability: Weekdays 2pm - 5pm ETA: May 3, 2024

[roslynwythe]

@DrAcula27 Please update the "Potential Solutions (draft)" section in the body of the ER, then let me know and I'll request approval from Bonnie. Thanks again for writing this ER.

[DrAcula27]

@roslynwythe Done! If it looks good, please request approval from Bonnie, and I will create the issue.

[roslynwythe]

@DrAcula27 I think the "Proposed Solution (draft)" section would be a bit clearer if your "Replace" section matched section 2.7.d in its entirety, as in my comment https://github.com/hackforla/website/issues/6710#issuecomment-2078905090

[DrAcula27]

@roslynwythe Done. Is that more clear?

[roslynwythe]

Hi @DrAcula27 I just realized that there is another issue (from a separate ER) for the update of Section 2.7.d to provide the complete command git pull upstream gh-pages. I still think that the issue that you have proposed in this ER has merit because the proposed text is clearer. If you would like to proceed, you should

• [x] Edit your "Replace" code to include the full command git pull upstream gh-pages
• [x] To avoid confusion and uncertainty about the "Replace" section, we can allow the other issue to complete before your new issue is prioritized. This will be accomplished by adding a "Dependency" to your issue. In this ER under "Potential Solutions", you might want to mention that the issue you are proposing should have a dependency on #6581. Then when you create the issue, use the issue template "Blank Issue Form with Dependency".

[DrAcula27]

Hi @roslynwythe I updated the ER as you mentioned in your previous comment.

• My "Replace" code includes the full command git pull upstream gh-pages
• I added the following text to the top of the "Potential Solutions" section of the ER:

Because there is another issue that also addresses this portion of CONTRIBUTING.md, this ER is dependent on it. When creating the issue for this ER, use the issue template "Blank Issue Form with Dependency" and make sure it is dependent on:

• https://github.com/hackforla/website/issues/6581

Once the dependent issue is completed, I recommend the following:

[DrAcula27]

@roslynwythe I fixed the "Replace" code so that it should be in line with what will be there after the dependent issue is resolved.

[ExperimentsInHonesty]

@dracula I recommend you wrap this part of your issue into copy blocks

Replace:

#### **2.7.d Working on an issue (4): Pulling from upstream before you push**

**IMPORTANT:** Before you push your local commits to your repository, sync your fork to the main Hack For LA website repository. `git pull upstream` will ensure that your local repository is up-to-date with the main site:

```bash
git pull upstream gh-pages
```
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:

#### **2.7.d Working on an issue (4): Pulling from upstream before you push**

**IMPORTANT:** Before you push your local commits to your repository, sync your fork to the main Hack For LA website repository.  You can 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>

Next bring upstream changes into your topic branch.  With your topic branch checked out, run 

```bash
git pull upstream gh-pages
```

[DrAcula27]

@ExperimentsInHonesty Thank you for the input! I wrapped the text in copy blocks as requested.

[jphamtv]

Hi @DrAcula27 - in your "Replace:" and "with" copy blocks please replace the following snippets:

with:

After you make the changes, add the ready for merge team label and someone from the team will review it. Thanks!

[DrAcula27]

@jphamtv I made the edits you requested, plus added indentation to prevent bad formatting created otherwise. Is this what you were going for?

[t-will-gillis]

Hey @DrAcula27 it looks like you have picked up the edits from ExperimentsInHonesty and jphamtv- this appears ready to make into an issue so I am moving it to that column "Epics and ERs that are ready to be made into issues". I am leaving you assigned to this since you have already done the work writing the proposed steps and I assume you plan to create the issue.

[t-will-gillis]

• Issue #7042 was created to address this ER; closing the ER as completed.

[HackforLABot]

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