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 Section2.7.b - making sure devs checkout gh-pages first #5698

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

Update CONTRIBUTING.md Section2.7.b - making sure devs checkout gh-pages first #5698

roslynwythe opened this issue Oct 10, 2023 · 4 comments · Fixed by #5936
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 the instructions in CONTRIBUTING.md 2.7.b "Working on an issue (2): Create a new branch where you will work on your issue", we need to ensure that the developer has checked out the gh-pages branch prior to proceeding to create the issue branch, and that after making files changes, the developers uses caution when using git add to prevent inclusion of unwanted files in the subsequent commit.

Action Items

  • In your local IDE, open CONTRIBUTING.md and navigate to "Working on an issue (2): Create a new branch where you will work on your issue"
  • Replace:
The `git checkout` command will create and change to a new branch where you will do the work on your issue.  In git, the checkout command lets you navigate between different branches.  Using the `-b` flag you can create a new branch and immediately switch into it. 

For example,if we creating a new issue branch off [Update ‘Give’ image credit link and information - #2093](https://github.com/hackforla/website/issues/2093):

with

If you have not already done so, run `git checkout gh-pages` to switch the working directory to the `gh-pages` branch and then update `gh-pages` with upstream changes as described above in Section 2.7.a. 

Using the `-b` flag you can also use the `git checkout` command to create a new branch and immediately switch into it.  

For example,if we creating a new issue branch for [Update ‘Give’ image credit link and information - #2093](https://github.com/hackforla/website/issues/2093):
  • Replace:
When you've finished working on your issue, follow the steps below to prepare your changes to push to your repository.

with

We urge developers to be cautious using `git add`.  In general it is not advisable to use `git add -all` or `git add .`.  Rather, run `git status`, examine the output carefully, and then add only those files specifically related to the current issue.  This will ensure that no extraneous files are included in the subsequent commit.  

When you've finished working on your issue, follow the steps below to prepare your changes to push to your repository.
  • 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.md 2.7.b "Working on an issue (2): Create a new branch where you will work on your issue"
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 ready for product labels Oct 10, 2023
@roslynwythe

This comment was marked as resolved.

@roslynwythe roslynwythe changed the title Update CONTRIBUTING.md Section2.7.b Working on an issue (2): Create a new branch where you will work on your issue Update CONTRIBUTING.md Section2.7.b - making sure devs checkout gh-pages first Oct 10, 2023
@ExperimentsInHonesty ExperimentsInHonesty added this to the 08. Team workflow milestone Nov 6, 2023
@roslynwythe

This comment was marked as resolved.

Copy link

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

@jphamtv
Copy link
Member

jphamtv commented Nov 24, 2023

Availability for this week: Monday-Friday 12–2 PM, 8–10 PM (PST)
My estimated ETA for completing this issue: 10 PM 11/26/23

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
Development

Successfully merging a pull request may close this issue.

3 participants