How to read and interpret labels for TDM - hackforla/tdm-calculator GitHub Wiki

Introduction

Labels are the backbone of how we organize our massive project. Each label give a small piece of information that quickly summarizes the content of the issue before it is read. In most cases, it informs us on what to do regarding the issue without reading them, saving us tons of time and headaches.Therefore,learning about and understanding the purpose of each label is the job of everyone on the team. This guide is made to introduce you to labels, how to read them, and how to use them effectively!

The rest of this wiki will divide the labels into broad groups:labels for new members,labels for continuing members,and labels for team leads. We will also provide the following relevant information for each label:

Name: the name of a label Description: The official description of the label and Notes on how this label is used for TDM Calculator.

For TDM, we have many roles, such as dev, PM, user researchers, and more. When looking for an issue to work on, besides looking in the Prioritized backlog, you must also be able to differentiate between issues that are for a developer vs for other teams. Our role labels are used to mark the role that the issue is for. You will recognize these labels because they are prefixed with role: [name of role], for example role: design. The following are the role labels we have.

Click to open

• Name: role: missing
• Description: No role has been assigned

 

• Name: role: Dev Lead
• Description: Tasks only for dev lead

 

• Name: role: UX/UI research
• Description: Tasks related to UX/UI Research

 

• Name: role: back end/devOps
• Description: Tasks for back-end developers

 

• Name: role: UX/UI design
• Description: Tasks for designers

 

• Name: role: front end
• Description: Tasks for front end developers

 

• Name: role: devops
• Description: Tasks related to devops

 

• Name: role: security
• Description: Tasks related to security

 

• Name: role: product management
• Description: Tasks related to Product Management and Project Managers

 

• Name: role: UX/UI Research lead
• Description: Tasks only for UX/UI Research lead

 

• Name: role: database
• Description: Tasks related to database deveplopment

 

• Name: role: ux content writing
• Description: Tasks related to UX content writing

 

• Name: role: Org rep
• Description:

 

The Level series represents the overall difficulty of an issue. This label mainly addressed by leads only as they know the difficulty of an issue

Click to open

• Name: Level: missing
• Description: No level has been assigned to the task/issue

 

• Name: good first issue
• Description: Tasks can be done by new volunteers

 

• Name: level: easy
• Description: Tasks can be easily done

 

• Name: level: medium
• Description: Tasks is overall rated medium for difficulty

 

• Name: level: Hard
• Description: Tasks is overall rated difficult due to its complexity and time commitment

 

The Featureseries and the P-feature series (see [below][#pfeature]),go hand in hand with one another. These labels indicates, broadly, what the issue involves. For example, an issue marked with Feature: Accessibility means that the issue relates to the accessibility of our website or our repository. The main difference between Feature and P-feature is that the P-feature series are reserved for the pages of our website that the issue concerns, while Feature involves activity outside of our website's pages. Normally, a new developer does not need to know about these labels at all. However, continuing members are expected to create issues, and these labels are required when creating a new issue. For more information on issue creation, visit [this page][#howtocreateissues].

Click to open

• Name: Feature: API
• Description: Feature related to API

 

• Name: Feature: Wiki
• Description: For issues involving our wiki. If you are reading this, you are at our wiki!

 

• Name: Feature: Demo
• Description: Issue and tasks which are related to Demo.

 

• Name: Feature: Agenda
• Description: When the feature is related to Agenda or want to include the particular feature in agenda

 

• Name: Feature: Devops
• Description: Feature related to devops work

 

• Name: Feature: Spelling
• Description: Issue and tasks related to spelling mistake and changes

 

• Name: Feature: Analytics
• Description: For issues that involves analytics or something similar. Usually involves something data intensive

 

• Name: Feature: Exemption
• Description: Issue and tasks which are exemption

 

• Name: Feature: Recruiting
• Description: whenever TDM is recruiting for a role

 

• Name: Feature: Style Guide
• Description: Issue and tasks which are related to style guide

 

• Name: Feature: Transcript
• Description: For issues involving Transcript

 

• Name: Feature: Code Clean Up
• Description: For issues involving Code clean up only

 

• Name: Feature: User testing
• Description: Issue and tasks which are related to User testing

 

• Name: Feature: Accessibility
• Description: Related to Accessibility of the TDM Project

 

• Name: Feature: issue template
• Description: Tasks related to issue template only

 

• Name: Feature: Testing Error
• Description: when we are testing an error of a particular issue

 

• Name: Feature: Security testing
• Description: stuff related to security testing

 

• Name: Feature: Marcomm Materials
• Description: Related to Marking and communication Materials

 

• Name: Feature: Team Instructions
• Description: Issue which involves any team instructions

 

The P-Feature series go together with the Feature series (see [above][#feature]). In general, each label of the P-Feature series involves either a page on our website, or a reusable component.

Click to open

• Name: P-Feature: header
• Description: components that make up the top header on all TDM calculator pages

 

• Name: p-feature: footer
• Description: components that make up the bottom footer on all TDM calculator pages

 

• Name: p-feature: Side Bar
• Description: components that make up the side bar .

 

• Name: p-feature: Meta data
• Description: includes open graph tags, page titles and other head element

 

• Name: p-feature: about
• Description: about page for TDM calculator

 

• Name: p-feature: check list
• Description: check list of TDM calculator

 

• Name: p-eature: FAQ screen
• Description: FAQ related to TDM Calculator

 

• Name: P-Feature: DRO lookup
• Description: components related to DRO lookup

 

• Name: p-feature: My account
• Description: Users can edit and manage their own account information

 

• Name: p-feature: Navigation
• Description: nav elements like buttons, menu items, icons etc

 

• Name: p-feature: Admin Guide
• Description: Admin guide for TDM Calculator

 

• Name: P-feature: Snapshot
• Description: snapshot

 

• Name: p-feature: Feedback Page
• Description: Feedback page for TDM calculator

 

• Name: p-feature: Bonus Packages
• Description: users are informed about the bonus packages they are eligible for

 

• Name: p-eature: privacy policy
• Description: All users privacy related issues

 

• Name: p-feature: Strategy Cost
• Description: if users wants to know what the average costs are

 

• Name: p-eature: My project pages
• Description: my project page related to TDM calculator

 

• Name: p-feature: Registration page
• Description:Registration page

 

• Name: p-feature: Manage Submissions
• Description: Manage Submissions for TSM Calculator

 

A dependency means that an issue requires some other work to be finished before this issue can start. For example, if we need to create a new component, but we are in the middle of reorganizing our CSS, it is not best to create a new component now. Therefore, we need to add a Dependency label to indicate that there is CSS work (the dependency) that needs to resolve before work can start. For more about dependencies, take a look at [our wiki on issues and issue creation][#howtocreateissues].

• Name: Dependency
• Description: An issue is blocking the completion or starting of another issue, meaning another issue needs to be resolved before work can begin.

The priority series, these labels indicates, broadly, what are the priorities for these issues. For example, an issue marked with Feature: Must have means that the issue is must have priority.

Click to open

• Name: priority: Missing
• Description: priority is missing for this issues.

 

• Name: priority: Must Have
• Description: this issue is must have for TDM calculator

 

• Name: priority: Should Have
• Description: this issue is should have for TDM calculator

 

• Name: priority: could have
• Description: this issue is could have for TDM calculator

 

• Name: priority:won't have this time
• Description: this issue is for won't have this time for TDM calculator

 

• Name: priority: won't fox
• Description: this will not worked on

 

The Ready for Prioritization label is a label chiefly used to mark that an issue is of good quality and is ready to be approved for adding to the backlog. You can learn more about this label from [our wiki on issue creation][#howtocreateissues]. This gist of this label is that it is added to issues on the ["New Issue Approval" column][#issueapprovalcolumn] to signal to the product team that the issue has been created and edited by the other teams. Only team leads should ever put on this label as they are responsible for editing issues.

• Name: Ready for Prioritization
• Description:
• Default: no
• Usage: Only to be used by a lead on issues in the Issue approval column. It is only used to indicate that an issue is fully-formed according to the standards of the team lead.

 

The size series, these labels indicates, what are the size for these issues in terms of hours. For example, an issue marked with size: 1 pt means that the issue is can be done with in 6-8 hours.

Click to open

• Name: size : Missing
• Description: size is missing for this issues.

 

• Name: size: 0.25 pt
• Description: can be done in 1.5 hours or less

 

• Name: size: 0.5 pt
• Description: can be done in 2-3 hours or less

 

• Name: size: 1 pt
• Description: can be done in 4-6 hours

 

• Name: size: 2 pt
• Description: can be done in 7-12 hours

 

• Name: size: 3 pt
• Description: can be done in 13-18 hours

 

• Name: size: 5 pt
• Description: can be done in 19-30 hours

 

• Name: size: 8 pt
• Description: can be done in 31-48 hours

 

• Name: size: 13+pt
• Description: must be broken down in smaller issues

 

The milestone series, these labels indicates what is the milestone for this issues. For example, an issue marked with Milestone: Post Launch means that this issue can be done after post launch

Click to open

• Name: milestone : launch
• Description: issue needs to be done before launch

 

• Name: milestone: post launch
• Description: issue can to be done after launch

 

• Name: milestone: post launch clean up
• Description: this issue is for post launch clean up

 

• Name: milestone: handover
• Description: this issue is for handover

 

• Name: milestone: security
• Description: security related

 

• Name: milestone: compliance
• Description: compliance related

 

• Name: milestone: project management
• Description: project management related

 

The deck series, these labels indicates, where/at what stage does these issues belongs to in deck. For example, an issue marked with deck: staging means that the issue is added to the staging deck

Click to open

• Name: deck : Missing
• Description: deck is missing for this issues.

 

• Name: deck: staging
• Description: the issue is added to the staging deck

 

• Name: deck: add to staging
• Description: this issue needs to be added to the staging

 

• Name: deck: stakeholder presentation
• Description: stakeholder slide deck

 

• Name: deck: staging not for stakeholders
• Description: staging not for stakeholders