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

Replace Github with GitHub in CONTRIBUTING.md Section 1.4 #7439

Open
8 tasks
daras-cu opened this issue Sep 12, 2024 · 0 comments
Open
8 tasks

Replace Github with GitHub in CONTRIBUTING.md Section 1.4 #7439

daras-cu opened this issue Sep 12, 2024 · 0 comments
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

@daras-cu
Copy link
Member

daras-cu commented Sep 12, 2024

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

We need to replace instances of Github and github with GitHub so that we display the company name correctly.

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md
  • In section 1.4.b, replace
Verify that your local cloned repository is pointing to the correct `origin` URL (that is, the forked repo on your own Github account):

with

Verify that your local cloned repository is pointing to the correct `origin` URL (that is, the forked repo on your own GitHub account):
  • In section 1.4.c, replace
#### **1.4.c What if you accidentally cloned using the repository URL from the HackForLA Github (instead of the fork on your Github)?**

with

#### **1.4.c What if you accidentally cloned using the repository URL from the HackForLA GitHub (instead of the fork on your GitHub)?**

*Note there are two instances of Github that need to be corrected to GitHub in the above line

  • In section 1.4.c, replace
Set your forked repo on your Github as an `origin` remote:

with

Set your forked repo on your GitHub as an `origin` remote:
  • With CONTRIBUTING.md still open, make a note of the section in which the replaced content appears, so that you will know where to look in the document to preview the change.
  • 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

Merge Team

@daras-cu daras-cu 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 labels Sep 12, 2024
@daras-cu daras-cu moved this to New Issue Approval in P: HfLA Website: Project Board Sep 12, 2024
@daras-cu daras-cu added the ready for dev lead Issues that tech leads or merge team members need to follow up on label Sep 12, 2024
@ExperimentsInHonesty ExperimentsInHonesty removed the ready for dev lead Issues that tech leads or merge team members need to follow up on label Sep 14, 2024
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
Status: Prioritized backlog
Development

No branches or pull requests

2 participants