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

Epic: Create Issues to Correctly Capitalize "Slack" in CONTRIBUTING.MD #6844

Closed
11 tasks done
tony1ee opened this issue May 10, 2024 · 7 comments
Closed
11 tasks done
Assignees
Labels
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 Dependency An issue is blocking the completion or starting of another issue epic Feature: Onboarding/Contributing.md Issue Making: Level 1 Make issues from a template and a spreadsheet role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less

Comments

@tony1ee
Copy link
Member

tony1ee commented May 10, 2024

Dependency

Overview

We need to create issues to correctly capitalize "Slack" in CONTRIBUTING.MD when it means when it's used to refer to the app or the company.

Details

We need to fix the following instances:

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

Action Items

For each item in Details above, perform the following actions:

  • Create an issue using Blank Issue Template, or by clicking here
  • Change the Title to Fix Capitalization of "Slack" in CONTRIBUTING.MD
  • Replace the description with the following:
### 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](https://www.hackforla.org/getting-started).
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](https://github.com/hackforla/website/blob/7f0c132c96f71230b8935759e1f8711ccb340c0f/CONTRIBUTING.md).
   
### 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
- [ ] Release the dependency for this issue in #6844. If all the dependencies have been completed, close that issue.

### Resources/Instructions
- [Getting started with writing and formatting on GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)
- For QA to validate change: https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.MD?plain=1

This issue is part of Issue Making Issue #6844 and ER #6163.
  • in Overview, replace [INSERT_LINE_PERMALINK] with permalink of line of code
  • in Action Items, replace [INSERT_LINE_NUMBER] with actual line number
  • Remove all existing labels, and apply the following labels: Complexity: Small, Feature: Onboarding/Contributing.md, role: front end, size: 0.5pt, ready for merge team
  • submit new issue
  • add the newly created issue to Issues Created list in issue Epic: Create Issues to Correctly Capitalize "Slack" in CONTRIBUTING.MD #6844

Issues Created

Resources/Instructions

This Issue Making Issue is part of ER #6163

@tony1ee tony1ee added role: front end Tasks for front end developers Feature: Onboarding/Contributing.md 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 Issue Making: Level 1 Make issues from a template and a spreadsheet Complexity: See issue making label See the Issue Making label to understand the issue writing difficulty level ready for dev lead Issues that tech leads or merge team members need to follow up on labels May 10, 2024
@tony1ee tony1ee added epic size: 0.5pt Can be done in 3 hours or less and removed size: 0.25pt Can be done in 0.5 to 1.5 hours labels May 10, 2024
@roslynwythe roslynwythe added Ready for Prioritization and removed ready for dev lead Issues that tech leads or merge team members need to follow up on labels May 10, 2024
@roslynwythe

This comment was marked as outdated.

Copy link

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

@del9ra
Copy link
Member

del9ra commented May 31, 2024

ETA: 10 PM 06/02/2024
Availability: 1-3 06/03/2024

@ExperimentsInHonesty ExperimentsInHonesty added the ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization label Jun 11, 2024
@LRenDO
Copy link
Member

LRenDO commented Jun 13, 2024

Hi @del9ra!

Nice work! The new issues look great. You appropriately added the correct line numbers for all three issues to be created. You also listed them on this issue in the appropriate section.

I have a couple requests that weren't explicitly in the instructions and are not required, but would be helpful. Since we say "Release the dependency for this issue in #6844. If all the dependencies have been completed, close that issue." It would be helpful to have a Dependency section at the top with a checklist that includes the three issues you listed in the Issues Created section. #5248 has an example of a dependency section. It would also be helpful if we begin the title with Epic: similar to #5248 as it makes it quicker to recognize it's not a single issue.

Feel free to ping me here if you have questions or need clarification.

@del9ra del9ra changed the title Create Issues to Correctly Capitalize "Slack" in CONTRIBUTING.MD Epic: Create Issues to Correctly Capitalize "Slack" in CONTRIBUTING.MD Jun 14, 2024
@del9ra
Copy link
Member

del9ra commented Jun 14, 2024

Hi @del9ra!

Nice work! The new issues look great. You appropriately added the correct line numbers for all three issues to be created. You also listed them on this issue in the appropriate section.

I have a couple requests that weren't explicitly in the instructions and are not required, but would be helpful. Since we say "Release the dependency for this issue in #6844. If all the dependencies have been completed, close that issue." It would be helpful to have a Dependency section at the top with a checklist that includes the three issues you listed in the Issues Created section. #5248 has an example of a dependency section. It would also be helpful if we begin the title with Epic: similar to #5248 as it makes it quicker to recognize it's not a single issue.

Feel free to ping me here if you have questions or need clarification.

Hello @LRenDO,
I've updated the issue. Could you please take a look?
Thank you!

@LRenDO
Copy link
Member

LRenDO commented Jun 14, 2024

Hi @del9ra! Looks great. Thanks for the updates. When I included the example it had some completed dependencies and I didn't mention that the dependencies should be unchecked until they are completed. I went ahead and unchecked them since my example wasn't clear. Everything else looks great! Approving your work by removing you as assignee, but leaving the issue open since it is an epic with dependencies. Thanks for creating these issues!

@LRenDO LRenDO 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 labels Jun 14, 2024
@ExperimentsInHonesty ExperimentsInHonesty added Dependency An issue is blocking the completion or starting of another issue and removed Ready for Prioritization labels Jun 15, 2024
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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 Dependency An issue is blocking the completion or starting of another issue epic Feature: Onboarding/Contributing.md Issue Making: Level 1 Make issues from a template and a spreadsheet role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less
Projects
Development

No branches or pull requests

5 participants