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

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

Open
8 tasks
danvgar opened this issue Sep 2, 2024 · 7 comments
Open
8 tasks
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.25pt Can be done in 0.5 to 1.5 hours time sensitive Needs to be worked on by a particular timeframe

Comments

@danvgar
Copy link
Member

danvgar commented Sep 2, 2024

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.
  • Remove the following
```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 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 danvgar 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.25pt Can be done in 0.5 to 1.5 hours labels Sep 2, 2024
@github-project-automation github-project-automation bot moved this to New Issue Approval in P: HfLA Website: Project Board Sep 2, 2024
@ExperimentsInHonesty

This comment was marked as resolved.

@ExperimentsInHonesty ExperimentsInHonesty added ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization Added to dev/pm agenda labels Sep 15, 2024
@danvgar

This comment was marked as resolved.

@ExperimentsInHonesty ExperimentsInHonesty added Ready for Prioritization and removed ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization Added to dev/pm agenda Ready for Prioritization labels Sep 17, 2024
@ihop-56 ihop-56 self-assigned this Oct 20, 2024
@HackforLABot

This comment was marked as outdated.

@HackforLABot

This comment was marked as outdated.

@ExperimentsInHonesty ExperimentsInHonesty added time sensitive Needs to be worked on by a particular timeframe and removed Ready for Prioritization labels Oct 30, 2024
@aswutmaxcy aswutmaxcy self-assigned this Nov 7, 2024
@aswutmaxcy aswutmaxcy moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Nov 7, 2024
@HackforLABot HackforLABot moved this from In progress (actively working) to New Issue Approval in P: HfLA Website: Project Board Nov 7, 2024
@HackforLABot

This comment was marked as resolved.

@aswutmaxcy aswutmaxcy moved this from New Issue Approval to Prioritized backlog in P: HfLA Website: Project Board Nov 7, 2024
@mchait18 mchait18 self-assigned this Nov 11, 2024
@HackforLABot

This comment was marked as resolved.

@HackforLABot HackforLABot moved this from Prioritized backlog to New Issue Approval in P: HfLA Website: Project Board Nov 11, 2024
@mchait18 mchait18 self-assigned this Nov 12, 2024
@HackforLABot

This comment was marked as duplicate.

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.25pt Can be done in 0.5 to 1.5 hours time sensitive Needs to be worked on by a particular timeframe
Projects
Status: Prioritized backlog
Development

No branches or pull requests

6 participants