Skip to content

Update CONTRIBUTING.md Section 2.7.d with correct upstream branch #6581

@danvgar

Description

@danvgar

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

The readability and accuracy of our CONTRIBUTING.md documentation is crucial for ensuring a smooth onboarding process for new members. The current documentation in Section 2.7d does not provide an upstream branch for the user to pull from prior to pushing their code, and results in an error because a branch was not specified. We need to update this code to include the correct upstream branch.

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md
  • Replace
**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
```

with

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

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

Metadata

Metadata

Assignees

Labels

Complexity: SmallTake this type of issues after the successful merge of your second good first issueFeature: Wikirole: back end/devOpsTasks for back-end developersrole: front endTasks for front end developerssize: 0.5ptCan be done in 3 hours or less

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions