website icon indicating copy to clipboard operation
website copied to clipboard

Section 2.7e of CONTRIBUTING.md has code that will not work in terminal

Open danvgar opened this issue 1 year ago • 3 comments

Overview

The code block for incorporating upstream changes at 2.7.e Working on an issue (5): Incorporating changes from upstream of website/CONTRIBUTING.md utilizes bash comments that may not run successfully on some operating systems or machines when copy-and-pasted. The comments need to be removed from this code block, and rewritten after the code-block for explanation purposes. .

Action Items

  • [ ] Open website/CONTRIBUTING.md in your IDE
  • [ ] Go to section "2.7.e Working on an issue (5): Incorporating changes from upstream"
  • [ ] At each line of code, remove all text after and inclusive of the # symbols. These are comments that prevent the code from executing properly.
```bash
git checkout upstream-gh-pages # Move to the branch you want to merge with.
git pull  # This updates your tracking branch to match the gh-pages branch in this repository
git checkout gh-pages  # Move back to your gh-pages branch
git merge upstream-gh-pages  # Merge to bring your gh-pages current.```
  • [ ] Replace the code block and subsequent text with the below
1. Move to the branch you want to merge with.
```bash
git checkout upstream-gh-pages 
```

2. Update your tracking branch with the latest changes from the `gh-pages` branch in this repository
```bash
git pull  
```

3. Move back to your gh-pages branch
```bash
git checkout gh-pages  
```

4. Merge your changes back into your `gh-pages` branch.
```bash
git merge 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

danvgar avatar Sep 02 '24 22:09 danvgar

@danvgar You created this issue 2 weeks ago, but it doesn't have ready for merge team or ready for dev lead label on it, so I don't think anyone has looked at it. I am going to add a ready for merge team label.

ExperimentsInHonesty avatar Sep 15 '24 21:09 ExperimentsInHonesty

@danvgar You created this issue 2 weeks ago, but it doesn't have ready for merge team or ready for dev lead label on it, so I don't think anyone has looked at it. I am going to add a ready for merge team label.

Apologies for missing that label, @ExperimentsInHonesty !

danvgar avatar Sep 16 '24 18:09 danvgar

Hello @ihop-56, we appreciate you taking on issue #7378, however it looks like you've already worked on enough issues of this complexity. Try checking out some of the issues of the next complexity from the Prioritized Backlog :)

We are going to unassign you from this issue so you can take on another issue.

Hfla appreciates you! :)

P.S. There is one exception to this rule/automation, and that is if you were away for a long time, and need to do the issue ladder again. If that is the case, please post the following note on the issue and on your Skills Issue (Pre-work Checklist). A Merge team member will reassign you to this issue, and will help you get assigned to subsequent issues up to medium size.

I am returning after a significant time away, and need to do the issue ladder again. Please assign me back to this issue.

HackforLABot avatar Oct 20 '24 22:10 HackforLABot

Hi @ihop-56, HfLA appreciates your interest in this issue, but please note that it is in the "New Issue Approval" column of the Project Board because it has not been finalized, approved, or prioritized, and so it is not ready for assignment. For this reason, you have been unassigned from this issue. Please remember to assign issues only from the "Prioritized Backlog" column.

The only exceptions to this rule are if you are writing an issue and the Draft label is applied, or if you are self-assigning to your "Pre-work Checklist" (the issue includes the Complexity: Prework label).

HackforLABot avatar Oct 25 '24 02:10 HackforLABot

Hello @aswutmaxcy, we appreciate you taking on issue #7378, however it looks like you've already worked on enough issues of this complexity. Try checking out some of the issues of the next complexity from the Prioritized Backlog :)

We are going to unassign you from this issue so you can take on another issue.

Hfla appreciates you! :)

P.S. There is one exception to this rule/automation, and that is if you were away for a long time, and need to do the issue ladder again. If that is the case, please post the following note on the issue and on your Skills Issue (Pre-work Checklist). A Merge team member will reassign you to this issue, and will help you get assigned to subsequent issues up to medium size.

I am returning after a significant time away, and need to do the issue ladder again. Please assign me back to this issue.

HackforLABot avatar Nov 07 '24 21:11 HackforLABot

Hello @mchait18, we appreciate you taking on this issue, however it looks like you're already working on another issue at this time. Please wait until your current issue is merged before taking on another issue. :)

We are going to unassign you from this issue so you can focus on your current issue.

Hfla appreciates you! :)

HackforLABot avatar Nov 11 '24 17:11 HackforLABot

Hi @mchait18, HfLA appreciates your interest in this issue, but please note that it is in the "New Issue Approval" column of the Project Board because it has not been finalized, approved, or prioritized, and so it is not ready for assignment. For this reason, you have been unassigned from this issue. Please remember to assign issues only from the "Prioritized Backlog" column.

The only exceptions to this rule are if you are writing an issue and the Draft label is applied, or if you are self-assigning to your "Pre-work Checklist" (the issue includes the Complexity: Prework label).

HackforLABot avatar Nov 12 '24 20:11 HackforLABot

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

HackforLABot avatar Nov 28 '24 00:11 HackforLABot

@HackforLABot

i. Availability: This week Wednesday 9AM - 6PM ii. By Sunday 12/01/2024

dvernon5 avatar Nov 28 '24 00:11 dvernon5