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

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

Open
6 of 8 tasks
tarang100 opened this issue Jan 6, 2021 · 18 comments
Open
6 of 8 tasks
Labels
Complexity: Medium Dependency An issue is blocking the completion or starting of another issue Draft Issue is still in the process of being created manual dependency release P-Feature: Toolkit https://www.hackforla.org/toolkit/ role: product Product Management size: missing Status: Updated No blockers and update is ready for review

Comments

@tarang100
Copy link
Contributor

tarang100 commented Jan 6, 2021

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

@tarang100 tarang100 added documentation Documentation creation role: product Product Management Collaborative Work P-Feature: Toolkit https://www.hackforla.org/toolkit/ and removed Collaborative Work labels Jan 6, 2021
@tarang100 tarang100 changed the title Updating the Guide on Getting the Most Out of GitHub Issues Adding 'Label' Information to the Guide on Getting the Most Out of GitHub Issues Jan 6, 2021
@tarang100 tarang100 added Role: UI Complexity: Medium and removed role: product Product Management documentation Documentation creation labels Jan 10, 2021
@pawan92

This comment has been minimized.

@ashleylin1
Copy link
Member

Progress: Created draft on Figma
Blockers: Need some parts of the instruction text to be looked over and added to. For the last task, I added a fake screenshot but I don't know what to write for the text explaining why only the first role label is used.
Availability: Weekdays after 3pm
ETA: not entirely sure what this means

@ashleylin1
Copy link
Member

Progress: Updated design on Figma with fixed copy and currently adding reviewers to look over the page
Blockers: None
Availability: Weekdays after 4pm
ETA: 1 week

@tarang100
Copy link
Contributor Author

tarang100 commented Jan 31, 2021

The PM team will review the misc labels and update the language. And @ashleylin1 will update the images not to have the lines from the screenshots

@ashleylin1
Copy link
Member

Progress: images have been reuploaded without the lines between them.
Blocker: need the role label "UX" to be changed to "Role: UX"

@ExperimentsInHonesty
Copy link
Member

@ashleylin1 I changed it to role: UX - about half were one way and the other half the other way (cap and no cap). So now they are all lowercase, if you think that was the wrong decision, please let me know.

@ashleylin1
Copy link
Member

Progress: finished added "Role: UX" label and description text for Role and Miscellaneous labels
Blockers: none; need final review over the Figma
Availability: Weekdays after 4pm

@daniellex0
Copy link
Member

daniellex0 commented Feb 7, 2021

*Discuss with Danielle: make sure follows design system standards

@daniellex0
Copy link
Member

I reviewed the design for standardization with the rest of the guide page and the design system, and it's ready to go 👍

@daniellex0 daniellex0 added the Dependencies Pull requests that update a dependency file label Feb 21, 2021
@pawan92
Copy link

pawan92 commented Feb 21, 2021

@ashleylin1 Can you please add the labels for status?

@pawan92 pawan92 added the To Update ! No update has been provided label Feb 21, 2021
@ExperimentsInHonesty
Copy link
Member

@kristine-eudey we need to revise this issue, let's talk about it in our next meeting

@ExperimentsInHonesty ExperimentsInHonesty added role: product Product Management and removed Dependencies Pull requests that update a dependency file labels Sep 7, 2021
@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Sep 7, 2021

product needs to come up with the list of labels they want included in the guide and then we can meet with design to identify how the current figma needs to change.

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Sep 8, 2021

must have labels
size
feature
role

optional labels
enhancement for new features to the site or organization
bug (a bug is not necessarily time sensitive, if it is also use the time sensitive label)
time sensitive
discussion (when does this label get used?)

Labels in question
collaborative work - see issue #2211 & #1850

labels to delete
research

@blulady

This comment was marked as resolved.

@blulady

This comment was marked as resolved.

@github-actions github-actions bot added the Status: Updated No blockers and update is ready for review label Mar 25, 2022
@JessicaLucindaCheng

This comment was marked as resolved.

@blulady blulady removed their assignment Mar 27, 2022
@7kram 7kram added the Draft Issue is still in the process of being created label Nov 28, 2022
@7kram
Copy link
Member

7kram commented Nov 30, 2022

words

why is this under the action items?

some of these action items are unclear

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Dependency An issue is blocking the completion or starting of another issue Draft Issue is still in the process of being created manual dependency release P-Feature: Toolkit https://www.hackforla.org/toolkit/ role: product Product Management size: missing Status: Updated No blockers and update is ready for review
Projects
Development

No branches or pull requests

10 participants