ER: Redundant/confusing instructions in CONTRIBUTING.md Section 2.7.d and 2.7.e

[roslynwythe]

Emergent Requirement - Problem

In Section 2.7.d we instruct devs to sync their fork with origin and to pull upstream changes from gh-pages into their topic branch. Many of the remaining instructions in 2.7.d and 2.7.e are redundant in most cases.

Specifics:

• in 2.7.d i, the console output and the associated instructions are based on the assumption that the developer has executed a git fetch, but actually at the beginning of 2.7.d, devs are instructed to use a git pull. This leads to some confusing and unnecessary instructions.
• in 2.7.e, there are several methods provided for devs to sync their fork with the upstream repository, however that would have already been accomplished (in a simpler manner) by following the instructions at the beginning of Section 2.7.d. In addition, the instructions in 2.7.e are confusing because several different, alternative methods are provided for syncing the fork. If we choose to present various methods to sync the repos, the text should be enhanced or restructured to reflect that.
• It would be useful to explain why the git rebase is preferred over git merge and under what circumstances the git rebase would be appropriate. Also if the user completed the git pull upstream gh-pages command instructed in Section 2.7.d, then it would seem to be unnecessary to do either a git rebase or a git merge.

Issue you discovered this emergent requirement in

Date discovered

Did you have to do something temporarily

• YES
• NO

Who was involved

@roslynwythe

What happens if this is not addressed

When faced with pulling in upstream changes into a topic branch, new developers may be confused and give up.

Resources

https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md#27d-working-on-an-issue-4-pulling-from-upstream-before-you-push

Recommended Action Items

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

Potential solutions

• Start with Update CONTRIBUTING.md Section 2.7.d and 2.7.e #7617 as a preliminary/ draft template for writing this issue.
• Specify edits to CONTRIBUTING.md that resolves the issues mentioned above.
• When you have made the edits to Update CONTRIBUTING.md Section 2.7.d and 2.7.e #7617, move that issue from "Ice Box" to "Questions/ In Review" and add ready for merge team label.

[github-actions]

Hi @roslynwythe.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:

• Complexity, Role, Feature

NOTE: Please ignore this comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards.
To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

• Wiki: How to create issues
• Wiki: How to read and interpret labels