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 Project Profile Card review issue template #7596

Open
18 tasks
ExperimentsInHonesty opened this issue Oct 15, 2024 · 3 comments
Open
18 tasks

Update Project Profile Card review issue template #7596

ExperimentsInHonesty opened this issue Oct 15, 2024 · 3 comments
Assignees
Labels
Complexity: Medium Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly ready for dev lead Issues that tech leads or merge team members need to follow up on role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours

Comments

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Oct 15, 2024

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.
  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

We need to update the Project Profile Card review issue template, so that when new issues get made with the template, the instructions for how to update the issue are part of the template.

Action Items

  • Open the file /.github/ISSUE_TEMPLATE/project-profile-card-review-and-update.yml in your code editor

  • At the bottom of the template, you will be creating a detail block, with content from another issue

    • add the following text
      <details><summary>Instructions for Website team, after this issue is submitted by stakeholder</summary>
      <p>
      
    • Add the text from this comment 1
    • Add the following text
      </p>
      </details> 
      
  • Push your issue branch to your fork of the website repository, as described in Section 3.1.a of CONTRIBUTING doc, for example: git push --set-upstream origin test-update-labels-1234

  • The response from the push command will include the URL for creating a pull request. Copy/Paste the URL for creating the Pull Request for later.

  • Browse to your fork of the website repository and click Settings

    Screenshot of Repository Settings

    image

  • Change the default branch to the new issue branch

    Screenshot of Default Branch Setting

    image

  • Further down on the settings page under Features, check the Issues checkbox

    Screenshot of Issues Checkbox

    image

  • From the Issues page, click "New Issue" then locate the template updated by your issue, and click "Get Started" to open the issue template.

  • Copy the URL of the issue creation page as 2 and save for later use.

  • Verify the changes of the issue template.

  • Complete the Pull Request process by visiting the URL saved from the push command.

  • In the PR copy/paste this text immediately before the section "Screenshots of Proposed Changes Of The Website"

 ### For Reviewers
- Use this URL to check the updated issue template: [URL OF ISSUE TEMPLATE]
  • Replace the text in the square brackets (as well as the square brackets) with the URL of the updated issue template
  • Submit your pull request with your changes for review
  • After PR is merged, be sure to follow the steps above to change your default branch back to gh-pages and to disable Issues feature

Resources/Instructions

For QA to validate change: see 3

Footnotes

  1. Text to add to the template: https://github.com/hackforla/website/issues/7478#issuecomment-2357066233

  2. Template file: .github/ISSUE_TEMPLATE/project-profile-card-review-and-update.yml

  3. See the template in use: Issue: Project Profile Card review and update

@ExperimentsInHonesty ExperimentsInHonesty added Feature Missing This label means that the issue needs to be linked to a precise feature label. size: missing role missing Complexity: Missing labels Oct 15, 2024
@ExperimentsInHonesty ExperimentsInHonesty added the Draft Issue is still in the process of being created label Oct 15, 2024
@ExperimentsInHonesty ExperimentsInHonesty added ready for dev lead Issues that tech leads or merge team members need to follow up on Complexity: Medium role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly size: 1pt Can be done in 4-6 hours and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. size: missing Draft Issue is still in the process of being created role missing Complexity: Missing labels Oct 15, 2024
@ExperimentsInHonesty
Copy link
Member Author

@roslynwythe I created this issue in the style of prior issues (#7194) for fixing templates. Can you take a look at it and see if I did it right?

@ExperimentsInHonesty ExperimentsInHonesty self-assigned this Oct 15, 2024
@HackforLABot
Copy link
Contributor

Hi @ExperimentsInHonesty, we notice that you are assigned to an issue that you authored. Please remember to add the Draft label to this issue while you are working on it.

@daras-cu
Copy link
Member

@ExperimentsInHonesty one of the developers had a question tonight about the instructions to be used in this issue template from this resource: #7478 (comment)
Also referenced in these comments: #7478 (comment), #7478 (comment)

Where it says "- [ ] Choose Update comment button", initially when creating an issue the button says Submit new issue, so there was confusion about whether that was the correct button to use. Depending on if they replace the placeholder text in the template while initially creating the issue or submit the issue and then go back and edit it to replace the placeholder text, they will see a different button. I know it's trivial but maybe the line can be "- [ ] Choose Update comment or Submit new issue button"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly ready for dev lead Issues that tech leads or merge team members need to follow up on role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours
Projects
Status: New Issue Approval
Development

No branches or pull requests

3 participants