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 Section 3.1.b vi #5696

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

Update CONTRIBUTING.md Section 3.1.b vi #5696

roslynwythe opened this issue Oct 10, 2023 · 4 comments · Fixed by #5955
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 CONTRIBUTING.md "vi. after pull request is submitted/merged" we need to remove duplicate statements about removing an issue branch following PR merge, in order to avoid confusion.

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md 3.1.b, under "vi. After pull request is submitted/merged"
  • Remove the lines

Now you can move on to your next issue and create a new branch. (This ensures you don’t accidentally include the changes from your previous branch in your new branch)

From here, once your pull request is approved and merged you can pull the recent merge from the Hack For LA repository and delete your local branch:

```bash
git pull upstream gh-pages
git branch -d update-give-link-2093
```

Managing branches this way will keep the commit logs cleaner on the Hack For LA repository, versus merging your completed feature branches into your local repo.
  • 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 "vi. after pull request is submitted/merged"
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 labels Oct 10, 2023
@roslynwythe
Copy link
Member Author

As stated in the Overview, this section https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md#vi-after-pull-request-is-submittedmerged contains some duplicate instructions. I applied ready for product because there were several options about which language to retain so I thought PM should take a look. Thanks

@roslynwythe roslynwythe changed the title Update CONTRIBUTING.md Section [INSERT SECTION #] Update CONTRIBUTING.md Section 3.1.b vi Oct 10, 2023
@ExperimentsInHonesty
Copy link
Member

I'll add this to the agenda today. But I am fine with @roslynwythe 's judgement and if needed the wisdom of the merge team.

@ExperimentsInHonesty ExperimentsInHonesty added ready for dev lead Issues that tech leads or merge team members need to follow up on and removed ready for product labels Nov 6, 2023
@ExperimentsInHonesty ExperimentsInHonesty added this to the 08. Team workflow milestone Nov 6, 2023
@roslynwythe roslynwythe removed the ready for dev lead Issues that tech leads or merge team members need to follow up on label Nov 7, 2023
@james-aguirre james-aguirre self-assigned this Nov 30, 2023
Copy link

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

@james-aguirre
Copy link
Member

Availability: 5PM-7PM M-F.
ETA: 12/2/2023

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