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

ER: Find all the places that slack should be Slack and fix #6163

Closed
3 of 5 tasks
ExperimentsInHonesty opened this issue Jan 25, 2024 · 21 comments
Closed
3 of 5 tasks
Assignees
Labels
Complexity: Medium Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level Complexity: Small Take this type of issues after the successful merge of your second good first issue ER Emergent Request Feature: Onboarding/Contributing.md good first issue Good for newcomers Issue Making: Level 2 Make issue(s) from an ER or Epic P-Feature: Project Meetings https://www.hackforla.org/project-meetings role: front end Tasks for front end developers size: 0.25pt Can be done in 0.5 to 1.5 hours Status: Updated No blockers and update is ready for review time sensitive Needs to be worked on by a particular timeframe

Comments

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Jan 25, 2024

Emergent Requirement - Problem

Slack is a company name and should only be in lowercase (slack) when in a URL, variable or directory name (where the variables or directories are all lowercase).

Details

There are 161 files with some form slack in it.

Issue you discovered this emergent requirement in

Date discovered

2024-01-25

Did you have to do something temporarily

  • YES
  • NO

Who was involved

@ExperimentsInHonesty

What happens if this is not addressed

  • If it's public facing, it's unprofessional not to fix it.
  • if it's in our non-public facing code, it's best practices to use it consistently as intended

Resources

Examples of locations that could be changed

  • //styling for join slack and view github buttons
  • **If you have any other questions about your contributing process, feel free to reach out to the team in the [#hfla-site](https://hackforla.slack.com/archives/C4UM52W93) slack channel.**
  • Also, please let the tech leadership team know (through a slack message in the hfla-site channel as well as an @ mention in a comment of the issue that you would be working on) if you are planning to take a week off or a longer vacation.
  • - If you still do not see your changes after trying these steps, please feel free to reach out to the team in the [#hfla-site](https://hackforla.slack.com/archives/C4UM52W93) slack channel, or bring up your issue in a dev meeting.
  • - [ ] Note regarding weekly team meeting requirements: All website team members are required to attend at least 1 team meeting in a week (held on Wednesdays and Sundays). In case, you are unable in any given week, you should reach out to the design lead. Exceptions to this requirement may be provided on a case-by-case basis. Also, please let the design lead know (through a slack message in the hfla-site channel as well as an @ mention in a comment of the issue that you would be working on) if you are planning to take a week off or a longer vacation.
  • - Lastly, you can post your question in the hfla slack channel and link the issue you're working on, so other volunteers can see and respond
  • - [ ] Note regarding weekly team meeting requirements: All website team members are required to attend at least 1 team meeting in a week (held on Tuesdays, Thursdays and Sundays). In case, you are unable in any given week, you should reach out to the tech leadership team. Exceptions to this requirement may be provided on a case-by-case basis. Also, please let the tech leadership team know (through a slack message in the hfla-site channel as well as an @ mention in a comment of the issue that you would be working on) if you are planning to take a week off or a longer vacation.
  • - Then, add the label "Status: Help Wanted" so other developers can see it and potentially help answer your question. In addition, you will still need to post a Slack message or bring it up in meeting so we know you need help; see below for how to do that.
  • - Also, you can post your question on the hfla-site slack channel and link the issue you're working on, so other developers can see and respond.

Examples of locations it must be changed

Recommended Action Items

  • Make an issue template in a comment that will work for all the issues, so that each file reference can be in its own separate issue is easy to make
  • move this issue to the questions column and add the ready for merge team label with the following note in a comment
    Please review my issue template comments above, and let me know when I can start making issues from them
    
  • Once you receive the signoff, make issues

Potential solutions [draft]

@ExperimentsInHonesty ExperimentsInHonesty added Feature Missing This label means that the issue needs to be linked to a precise feature label. size: 0.25pt Can be done in 0.5 to 1.5 hours role missing Complexity: Missing labels Jan 25, 2024
@ExperimentsInHonesty ExperimentsInHonesty added good first issue Good for newcomers role: front end Tasks for front end developers Feature: Onboarding/Contributing.md P-Feature: Project Meetings https://www.hackforla.org/project-meetings ready for dev lead Issues that tech leads or merge team members need to follow up on Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. Complexity: Missing role missing labels Jan 25, 2024
@JessicaLucindaCheng JessicaLucindaCheng changed the title ER: ER: Find all the places that slack should be Slack and fix ER: Find all the places that slack should be Slack and fix Jan 26, 2024
@JessicaLucindaCheng JessicaLucindaCheng added the ER Emergent Request label Jan 26, 2024
@ExperimentsInHonesty ExperimentsInHonesty added Ready for Prioritization Complexity: Small Take this type of issues after the successful merge of your second good first issue Issue Making: Level 2 Make issue(s) from an ER or Epic and removed ready for dev lead Issues that tech leads or merge team members need to follow up on Ready for Prioritization labels Apr 2, 2024
@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 time sensitive Needs to be worked on by a particular timeframe and removed ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization labels Apr 30, 2024
@ExperimentsInHonesty
Copy link
Member Author

The time sensitive label only refers to the fact that we need the issues this ER will create. The time sensitive label should not be applied to the issues.

@tony1ee tony1ee self-assigned this May 2, 2024

This comment has been minimized.

@tony1ee
Copy link
Member

tony1ee commented May 2, 2024

Availability: 05/02/2024 afternoon and evening
ETA: 05/02/2024 EOD

@tony1ee
Copy link
Member

tony1ee commented May 2, 2024

Draft Issue Templates


Title: Correct Capitalization of Slack in CONTRIBUTING.MD

(complexity: small)

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 fix the following line of code to correctly capitalize "Slack" when it's used to refer to the app or the company in our code and content.
[INSERT_LINE_PERMALINK]

Action Items

  • Open the file CONTRIBUTING.MD in your code editor
  • On Line [INSERT_LINE_NUMBER], replace every slack with Slack when it's used to refer to the app and the company, do not make changes within URLs.
  • Changes to CONTRIBUTING.md should not be tested locally, rather they need to 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]

For Merge Team

Resources/Instructions


Title: Correct Capitalization of Slack in [INSERT_FILE_NAME] (for issue templates)

(complexity: medium)

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 fix the following line of code to correctly capitalize "Slack" when it's used to refer to the app or the company in our code and content.
[INSERT_LINE_PERMALINK]

Action Items

  • Open the file [INSERT_PATH_TO_FILE] in your code editor

  • On Line [INSERT_LINE_NUMBER], replace every slack with Slack when it's used to refer to the app and the company, do not make changes within URLs.

  • 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 [URL OF ISSUE TEMPLATE] and save for later use.

  • Verify the appearance 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

For Merge Team

Resources/Instructions

For QA to validate change: https://github.com/hackforla/website/blob/gh-pages/[INSERT_PATH_TO_FILE]?plain=1


Title: Correct Capitalization of Slack in [INSERT_FILE_NAME] (for all other files)

(good first issue)

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 fix the following line of code to correctly capitalize "Slack" when it's used to refer to the app or the company in our code and content.
[INSERT_LINE_PERMALINK]

Action Items

  • Open the file [INSERT_PATH_TO_FILE] in your code editor
  • On Line [INSERT_LINE_NUMBER], replace every slack with Slack when it's used to refer to the app and the company, do not make changes within URLs.
  • Using docker, confirm that the appearance of the project webpage is unchanged at all screen sizes. The project webpage URL can be found below under Resources.
  • Create a pull request with your changes

For Merge Team

Resources/Instructions

For QA to validate change: https://github.com/hackforla/website/blob/gh-pages/[INSERT_PATH_TO_FILE]?plain=1


@tony1ee
Copy link
Member

tony1ee commented May 9, 2024

Looks like

- Then, add the label "Status: Help Wanted" so other developers can see it and potentially help answer your question. In addition, you will still need to post a Slack message or bring it up in meeting so we know you need help; see below for how to do that.

does not need any changes as it's spelled correctly. I also verified this line in the current gh-pages latest commit.
This is the 8th item in the main comment.

@tony1ee
Copy link
Member

tony1ee commented May 10, 2024

Ready to be reviewed

@tony1ee tony1ee added the ready for dev lead Issues that tech leads or merge team members need to follow up on label May 10, 2024

This comment has been minimized.

@github-actions github-actions bot added the To Update ! No update has been provided label May 17, 2024
@tony1ee
Copy link
Member

tony1ee commented May 17, 2024

Progress: created 1 issue and 2 issue making issues.
Blockers: #6842 pending approval by @roslynwythe , the other two are approved by dev lead and pending prioritization
Availability: N/A
ETA: N/A

Expect to close this ER after all issues created are approved.

@tony1ee tony1ee added Status: Updated No blockers and update is ready for review and removed To Update ! No update has been provided labels May 17, 2024
@github-actions github-actions bot added To Update ! No update has been provided and removed Status: Updated No blockers and update is ready for review labels May 24, 2024
Copy link

@tony1ee

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

You are receiving this comment because your last comment was before Tuesday, May 28, 2024 at 12:06 AM PST.

Copy link

github-actions bot commented Jun 7, 2024

@tony1ee

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

You are receiving this comment because your last comment was before Tuesday, June 4, 2024 at 12:06 AM PST.

@github-actions github-actions bot added the 2 weeks inactive An issue that has not been updated by an assignee for two weeks label Jun 7, 2024
@tony1ee
Copy link
Member

tony1ee commented Jun 8, 2024

all created issues approved/prioritized. Closing this ER.

@tony1ee tony1ee closed this as completed Jun 8, 2024
@tony1ee tony1ee added Status: Updated No blockers and update is ready for review and removed 2 weeks inactive An issue that has not been updated by an assignee for two weeks labels Jun 8, 2024
@jphamtv jphamtv removed ready for dev lead Issues that tech leads or merge team members need to follow up on ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization labels Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level Complexity: Small Take this type of issues after the successful merge of your second good first issue ER Emergent Request Feature: Onboarding/Contributing.md good first issue Good for newcomers Issue Making: Level 2 Make issue(s) from an ER or Epic P-Feature: Project Meetings https://www.hackforla.org/project-meetings role: front end Tasks for front end developers size: 0.25pt Can be done in 0.5 to 1.5 hours Status: Updated No blockers and update is ready for review time sensitive Needs to be worked on by a particular timeframe
Projects
Development

No branches or pull requests

5 participants