ER: Generic good first issue template for developers

[JessicaLucindaCheng]

trafficstars

Emergent Requirement - Problem

• Since we write a lot of good first issues, it would be helpful to have a generic good first issue template for writing developer issues.
• This template would be used to write good first issues for role: front end and/or role: back end/devOps.

Issue you discovered this emergent requirement in

• #4362

Date discovered

2023-04-24 at Dev/PM meeting

Did you have to do something temporarily

• [x] YES - I just write issues using the regular blank issue template
• [ ] NO

Who was involved

@JessicaLucindaCheng @bonniewolfe

What happens if this is not addressed

We have to write good first issues using the blank issue template or blank issue form.

Resources

• Examples of good first issues:
  • #4449
  • #4491
  • #4141

Recommended Action Items

• [ ] Make a new issue for a developer to work on creating a generic good first issue template
  • [ ] The new issue should include the labels: Issue Making: Level 2 and Complexity: See issue making label.
• [ ] Discuss with Merge Team if you need help writing the issue or have questions

Potential solutions [draft]

[ExperimentsInHonesty]

• [x] Add to this a list of issues that could set the example for what the template issue looked like - Completed by @JessicaLucindaCheng

[Hritik1503]

I am interested to work on this issue under Quine. So please assign me this task to me.

[JessicaLucindaCheng]

@Hritik1503 In order to work on an issue, you need to be a member of Hack for LA. (There are no fees to join.) Please follow the steps on our Getting Started page and attend an onboarding session.

[ExperimentsInHonesty]

Here is a generic issue template that works for one-line changes to project Markdown files

### Prerequisites
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) and attend an onboarding session.
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/gh-pages/CONTRIBUTING.md).

### Overview
[Replace WITH DESCRIPTION OF WE NEED TO DO X FOR Y REASON]

### Action Items
- [ ] Change the GitHub link for [Replace PROJECT TITLE] so it resolves to the correct url
    - **Line 54** under `_projects/[Replace PROJECT.MD file name]`

From:
```
[Replace ADD EXISTING LINE]
```
To:
```
[Replace ADD NEW LINE]
```
- [ ] Using Docker, check the page [Replace HAS X STATE]  in mobile, tablet, and desktop views as on the current website
- [ ] Ensure that [Replace X CHECK] from the [Replace PAGE NAME](https://www.hackforla.org/[Replace PAGE URL]) and [Replace with PROJECT NAME](https://www.hackforla.org/projects/[Replace PROJECT PAGE URL]) both resolve to the new address

### Resources/Instructions
- Directory to find the page in once you have it in your IDE: `_projects/[Replace PROJECT.MD file name]`
- [Projects page](https://www.hackforla.org/projects/)
- Project page URL: https://www.hackforla.org/projects/[Replace PROJECT PAGE URL]
- Click on the filename below to see the source file code:
[Replace with LINK TO THE PROJECT PAGE IN THE GITHUB REPO]

[JessicaLucindaCheng]

Notes from Dev/PM on June 5th

• After the issue to create a generic good first issue template is completed, the following issues need to be made for slightly more specific templates:
  • A one line change for Markdown files in _project. See the template here: https://github.com/hackforla/website/issues/4591#issuecomment-1577775606
  • Possibly other scenarios

[github-actions[bot]]

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

[github-actions[bot]]

@JessicaLucindaCheng

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 Monday, February 26, 2024 at 11:06 PM PST.}

[JessicaLucindaCheng]

Issue Writing

• Availability: Not sure for this week
• ETA: Not sure for this week. There are a couple of time-sensitive issues that take priority over this issue.

Notes from Dev/PM on June 5th

• After the issue to create a generic good first issue template is completed, the following issues need to be made for slightly more specific templates:
  • A one line change for Markdown files in _project. See the template here: https://github.com/hackforla/website/issues/4591#issuecomment-1577775606
  • Possibly other scenarios

[github-actions[bot]]

@JessicaLucindaCheng

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, March 12, 2024 at 12:06 AM PST.}

[github-actions[bot]]

@JessicaLucindaCheng

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, March 19, 2024 at 12:06 AM PST.}

[JessicaLucindaCheng]

Issue Writing

• Progress: None
• Blockers: Water damaged laptop
• Availability: TBD - need to find a solution to my laptop problems
• ETA: TBD - need to find a solution to my laptop problems

Notes from Dev/PM on June 5th

• After the issue to create a generic good first issue template is completed, the following issues need to be made for slightly more specific templates:
  • A one line change for Markdown files in _project. See the template here: https://github.com/hackforla/website/issues/4591#issuecomment-1577775606
  • Possibly other scenarios

[github-actions[bot]]

@JessicaLucindaCheng

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, April 2, 2024 at 12:05 AM PST.}

[github-actions[bot]]

@JessicaLucindaCheng

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, April 9, 2024 at 12:06 AM PST.}

[JessicaLucindaCheng]

Issue Writing

• Progress: None
• Blockers: Water damaged laptop but it works now
• Availability: TBD - I need this week to catch up and prioritize what needs to be done.
• ETA: TBD - I need this week to catch up and prioritize what needs to be done.

Notes from Dev/PM on June 5th

• After the issue to create a generic good first issue template is completed, the following issues need to be made for slightly more specific templates:
  • A one line change for Markdown files in _project. See the template here: https://github.com/hackforla/website/issues/4591#issuecomment-1577775606
  • Possibly other scenarios

[github-actions[bot]]

@JessicaLucindaCheng

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, April 23, 2024 at 12:06 AM PST.}

[github-actions[bot]]

@JessicaLucindaCheng

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, April 30, 2024 at 12:06 AM PST.}

[JessicaLucindaCheng]

Issue Writing

• Progress: None
• Blockers: None
• Availability: TBD
• ETA: TBD

Notes from Dev/PM on June 5th

• After the issue to create a generic good first issue template is completed, the following issues need to be made for slightly more specific templates:
  • A one line change for Markdown files in _project. See the template here: https://github.com/hackforla/website/issues/4591#issuecomment-1577775606
  • Possibly other scenarios

[github-actions[bot]]

@JessicaLucindaCheng

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 14, 2024 at 12:06 AM PST.}

[github-actions[bot]]

@JessicaLucindaCheng

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, May 21, 2024 at 12:06 AM PST.}

[github-actions[bot]]

@JessicaLucindaCheng

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, May 28, 2024 at 12:06 AM PST.}

[JessicaLucindaCheng]

Issue Writing

• Progress: None
• Blockers: None
• Availability: TBD
• ETA: TBD

Notes from Dev/PM from 2023-06-05

• After the issue to create a generic good first issue template is completed, the following issues need to be made for slightly more specific templates:
  • A one line change for Markdown files in _project. See the template here: https://github.com/hackforla/website/issues/4591#issuecomment-1577775606
  • Possibly other scenarios

[github-actions[bot]]

@JessicaLucindaCheng

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, June 11, 2024 at 12:06 AM PST.}

[github-actions[bot]]

@JessicaLucindaCheng

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 18, 2024 at 12:06 AM PST.}

[github-actions[bot]]

@JessicaLucindaCheng

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 Wednesday, June 19, 2024 at 1:48 PM PST.}

[JessicaLucindaCheng]

Issue Writing

• Progress: None
• Blockers: None
• Availability: TBD
• ETA: TBD

Notes from Dev/PM from 2023-06-05

• After the issue to create a generic good first issue template is completed, the following issues need to be made for slightly more specific templates:
  • A one line change for Markdown files in _project. See the template here: https://github.com/hackforla/website/issues/4591#issuecomment-1577775606
  • Possibly other scenarios