Skip to content

Adding 'Label' Information to the Guide on Getting the Most Out of GitHub Issues #918

@tarang100

Description

@tarang100

Dependency

Issue #794 assigned to @alyssabenipayo

  • The wiki for the website team is working and there are pages about the labels.

Overview

We need to add the following details to the Guide on Getting the Most Out of GitHub Issues to enable a more comprehensive understanding for new volunteers

Action Items

  • Add the following text to the Guide on Getting the Most Out of GitHub Issues
    Labels:
    We use the following types of labels to help people find issues that are appropriate for: time on the team/ skill level
    1. Size of issue
    a. Good first issue: An issue that is really small, like a text change or similar. The majority of the time spent on this issue is about making sure the development/design/working environment is setup properly and they know how to contribute using GitHub/Figma
    b. Medium: This is an issue that is more time involved but doesn’t involve anything complex technically
    c. Large: An issue that probably requires research, or technical complexity that will take a long time. This issue might end up being broken down into smaller issues after initial research is delivered
    We use the following types of labels to help people find issues that related to a feature:
    2. Feature - x, y, z
    We use the following types of labels to help people find issues that are appropriate for: their practice area
    3. Role - front end, back end, architecture, UX/UI, product management
    Something something here
    4. Misc.
    a. Bug
    b. Documentation
    c. Dependencies

  • Ensure that the text added is formatted correctly

  • Check the text added for grammatical and spelling errors

  • Get it reviewed and finalized

  • Remove the text provided above, from the Google Doc on ‘How to’ use a Kanban board, by referencing this comment

  • In the meantime add the following to the document

  • Screen shot of a fake issue with every role label and just the one that is currently need, with some text that explains why you only use the first role label. For example (add screenshot of the issue on the board, with UI selected and the issue at the top of the prioritized backlog. - this way developers do not have to pay any attention to the issue.

### Overview
We need a X for Y reason

### Action Items
- [x] Product
   - [x] ideate
   - [x] define feature requirements
- [ ] UI
   - [ ] design the mockup
   - [ ] get feedback from product
- [ ] Product
   - [ ] signoff
- [ ] Development
   - [ ] design according to figma
- [ ] Product
   - [ ] UAT and signoff

### Resources
[figma file]()

Resources/Instructions

https://www.hackforla.org/guide-pages/github-issues.html
https://docs.google.com/document/d/11Fe7mNdmPBP5bD_yLJ1C0_I1TmoK47AuHHrdhdDyWCs/edit

where you can find the labels

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Ice box

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions