Skip to content

Update CONTRIBUTING.md Section 1.1 #8551

@kdaca19xx

Description

@kdaca19xx

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 CONTRIBUTING.md Section 1.1, we tell developers to send a message in the Slack channel asking permission to be added to the website repo. Assumedly during the onboarding process, devs are added to the repo. So with each onboarding, there are a couple of people that ask for access when they already have access.

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md
  • Replace
"In the `hfla-site` Slack channel, send an introductory message with your GitHub handle/username asking to be added to the Hack for LA website GitHub repository (this repository). NOTE: Once you have accepted the GitHub invite (comes via email or in your GitHub notifications), please do the following:"

with

"To be added to the Hack for LA website GitHub repository (this repository), you must complete the onboarding form.

<ins>If you did not complete the onboarding form,</ins> attend the next onboarding session (about 45 minutes in) to finish the process so you can receive an invite to the repository.

<ins>If you are sure you completed the onboarding form, but you still have not received an invite to the repository,</ins> go to the `hfla-site` Slack channel for help. Send an introductory message with your GitHub handle/username asking to be added.

Once you have been added to this repository, please do the following:</br>"

  • 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 https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md#11-dev-setup-1-join-the-repository-team

Resources/Instructions

CONTRIBUTING.md Section 1.1
Getting started with writing and formatting on GitHub

Metadata

Metadata

Assignees

Type

No type

Projects

Status

In progress (actively working)

Relationships

None yet

Development

No branches or pull requests

Issue actions