Northeastern-Electric-Racing / Northeastern-Electric-Racing/FinishLine

Work Package Template Epic

Open
#2,029 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic
Dominant language
TypeScript
Stars
36
Forks
9
Avg merge
4d 21h
Merged PRs (30d)
11

Description

Overview

Allow users to select templates for work packages to auto populate/add data to the work package form/

Sample templates: https://docs.google.com/document/d/1zqvbX-py6fH7_DrcAGJwiUTCwlj4u9sDHv315-wioIw/edit

Stakeholders

Product Stakeholder: @hari-am , @ninest
Software Stakeholder: @RChandler234 , @Peyton-McKee
Reference Users: Sofia Varner, Walter Stadolnik

User Stories
  1. As an Admin, I want create a library of reusable work package templates which are project specific, so that the Team Heads and Project Leads can quickly create work packages without starting from scratch.
  2. As a Team Head, I want to have a standardized template for specific project types, so that all team members use a consistent format and structure.
  3. As a Project Lead, I want to be able to auto-populate certain fields in work package templates, so that I can reduce the amount of manual data entry required.
  4. As a Project Team Member, I want to have clear and concise instructions, so that I can accurately fill out all the sections of work package templates without any confusion.
  5. As a new Project Team Member, I want to see examples of how to fill out certain fields in work packages, so that I can have a better understanding of the expected format.
Success Metrics

Once users use and create work package templates.

Rollout Plan

This feature is planned to be done by …. Eboard and heads can experiment with the feature for the next 1/2 months using the templates at https://docs.google.com/document/d/1zqvbX-py6fH7_DrcAGJwiUTCwlj4u9sDHv315-wioIw/edit

Out of Scope

Users creating personal templates. Templates will be managed by admins (project heads/leads).

Background / Context

Many work packages have similar details (expected activities, deliverables, blocked by). This feature will allow users to select a template while creating or editing the work package form to auto populate/add values to the form and make it easier to create similar work packages.

Admins can create templates with a name, stage, duration, blocked by, expected activities, and deliverables. All fields apart from the name are optional.

As for the "blocked by" work packages, we may either not include them in the template, or have them blocked by other work package under the same project.

Acceptance Criteria & Mock-ups

Mockups on Figma: https://www.figma.com/file/qmXuySSwfiD942HwmSSEMe/NER-Product-and-Design?type=design&node-id=5538-11885&mode=design&t=HmEtK5DC0dqbOYOH-0

New view of work package form (create and edit form):

image

The templates section has been added to the top of the form. When a template is selected, the data defined in the template will be appended to the form fields. No data will be overwritten.

Admin view to create work package templates:
https://www.figma.com/file/qmXuySSwfiD942HwmSSEMe/NER-Product-and-Design?type=design&node-id=5861-12554&mode=design&t=Mrhs0bLFAlljnRzt-0

image

The admin work package template form is the mostly the same as the work package form with a few minor differences. The only fields are template name, work package status, duration, blocked by, expected activities, and deliverables, all of which are optional.

image
Tickets
  • #2148
  • #2149
  • #2150
  • #2154
  • #2155
  • #2156
  • #2157
  • #2158
  • #2159
  • #2260
  • #2261
  • #2262
  • #2263
  • #2264
  • #2273
  • #2274
  • #2275
  • #2276

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the remaining tickets #2273–#2276, then read the linked Figma mock-ups and sample template document. Compare those tickets with the acceptance criteria and completed tickets to determine the remaining scope; done means the outstanding work package template behavior and admin workflow are implemented as specified.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.