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

Change the Feature: Administrative label to feature: spelling in spell check issue template #6857

Closed
17 tasks done
urvishp13 opened this issue May 17, 2024 · 8 comments · Fixed by #7036
Closed
17 tasks done
Assignees
Labels
Complexity: Medium Feature: Administrative Administrative chores etc. feature: spelling 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

@urvishp13
Copy link
Member

urvishp13 commented May 17, 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 change the Feature: Administrative label to the feature: spelling label in the spell check issue template. We're doing this, so the issues generated from this template are properly labeled.

Action Items

  • Open the file .github/ISSUE_TEMPLATE/spell-check-audit.md in your code editor.

  • In the labels property, replace

    Feature: Administrative
    

    with

    feature: spelling
    
  • 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-label-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

  • Browse to the Issues page, then click Labels

    Screenshot - creating labels in the test Repo

    image

  • Create labels corresponding to each label that was listed in the updated issue template. The color of the labels don't have to match those on the hackforla/website repository, but the text of the labels must match exactly.

  • 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 [URL OF ISSUE TEMPLATE] 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 the Issues feature.

Resources/Instructions

@urvishp13 urvishp13 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 May 17, 2024
@HackforLABot HackforLABot added this to New Issue Approval in Project Board May 17, 2024
@urvishp13 urvishp13 added the Draft Issue is still in the process of being created label May 17, 2024
@github-actions github-actions bot removed the Draft Issue is still in the process of being created label May 17, 2024

This comment was marked as spam.

@urvishp13 urvishp13 moved this from New Issue Approval to Questions / In Review in Project Board May 17, 2024
@urvishp13 urvishp13 added the Draft Issue is still in the process of being created label May 17, 2024
@urvishp13 urvishp13 moved this from Questions / In Review to New Issue Approval in Project Board May 17, 2024
@urvishp13 urvishp13 removed this from New Issue Approval in Project Board May 17, 2024
@urvishp13 urvishp13 added Complexity: Medium role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Feature: Administrative Administrative chores etc. size: 1pt Can be done in 4-6 hours ready for dev lead Issues that tech leads or merge team members need to follow up on and removed Complexity: Missing role missing 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 labels May 17, 2024
@urvishp13 urvishp13 added this to New Issue Approval in Project Board via automation May 17, 2024
@roslynwythe

This comment was marked as resolved.

@urvishp13 urvishp13 moved this from New Issue Approval to Questions / In Review in Project Board May 20, 2024
@roslynwythe roslynwythe removed the ready for dev lead Issues that tech leads or merge team members need to follow up on label May 29, 2024
@roslynwythe roslynwythe moved this from Questions / In Review to New Issue Approval in Project Board May 29, 2024
@ExperimentsInHonesty ExperimentsInHonesty added this to the 08. Team workflow milestone Jun 2, 2024
@ExperimentsInHonesty ExperimentsInHonesty moved this from New Issue Approval to Prioritized backlog in Project Board Jun 2, 2024
@santisecco santisecco self-assigned this Jun 2, 2024
Copy link

github-actions bot commented Jun 2, 2024

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

@santisecco santisecco moved this from Prioritized backlog to In progress (actively working) in Project Board Jun 2, 2024
@santisecco
Copy link
Member

I have a question. I want to confirm that I understood correctly.
"Create labels corresponding to each label that was listed in the updated issue template".
By "updated issue template" is this the file github/ISSUE_TEMPLATE/spell-check-audit.md after my changes?

Then by "The color of the labels don't have to match those on the hackforla/website repository" are these the labels from_https://github.com/hackforla/website/labels_?

Perhaps my question is obvious since by the issue's heading which says "spell check issue template" I can infer that refers to the file github/ISSUE_TEMPLATE/spell-check-audit.md

Finally by "then locate the template updated by your issue, and click "Get Started" to open the issue template." is this the file spell-check-audit.md in my fork?

@santisecco santisecco added the Status: Help Wanted Internal assistance is required to make progress label Jun 9, 2024
@santisecco
Copy link
Member

santisecco commented Jun 10, 2024

@urvishp13 Hi Urvish perhaps you can help me out with this doubt

@santisecco
Copy link
Member

Also I noticed that in the file "spell-check-audit.md" there's seems to be "back end/devOps" with two extra spaces being "back end/devOps", it's at the start of a new line so I don't know which of the two texts I must use in the label creation.

@santisecco
Copy link
Member

santisecco commented Jun 14, 2024

I have a blocker:
After reading again CONTRIBUTIG.md I'll be clearer in expressing my difficulties.
I do not clearly understand if the issue is refering to the file spell-check-audit.md by the term "template".
I also don't know if I am supposed to add the label "role: back
end/devOps" as it appears in the file or instead "role: back end/devOps"

Here's what I've done so far
1- Assumed that by template we mean the spell-check-audit.md
2- As the issue states "but the text of the labels must match exactly." when creating the labels I just copy/paste the text from the file. Starting from the first character in the word to the last. This made the label creation in Github have a few more spaces but the visual was not affected [image attached- note difference between "back end" and "front end"]

I want to know if that is correct before moving on with the rest.
The branch I'm working on is "change-label-spellcheck-6857"

Screenshot 2024-06-14 123203

@t-will-gillis
Copy link
Member

t-will-gillis commented Jun 14, 2024

Hi @santisecco

  • I agree that 'template' refers to spell-check-audit.md
  • For consistency, the label should have a single space, i.e. role: back end/devOps. I see what you are saying about how the existing template has two spaces. As a test, I added many extra spaces on all of the labels and it seems that the correct label gets selected still, but I would remove the extra space anyway.
    Thanks!

I am removing the Status: Help Wanted label, but if you still have questions feel free to ask and/or add the label back to this issue.

@t-will-gillis t-will-gillis removed the Status: Help Wanted Internal assistance is required to make progress label Jun 14, 2024
Project Board automation moved this from In progress (actively working) to QA Jun 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Feature: Administrative Administrative chores etc. feature: spelling 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
Development

Successfully merging a pull request may close this issue.

5 participants