hackforla / hackforla/tdm-calculator
Product: Update Designer Issue Workflow in Wiki and Design Issue Template
- Dominant language
- JavaScript
- Stars
- 68
- Forks
- 47
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 25
Description
### Overview
We need to update the Designer Issue Workflow in the wiki and issue template so that designers are clear on what we are asking them to do.
#### Details
Write instructions to add to wiki.
- Add a final section to the design team’s guidance called “When should I create one of these?” Which will be followed by an unordered list, and that each should go to its own page, that tells people when they should create the thing (e.g., new user workflow), and how to do it. This will help establish a consistent expectation for when designers should invest the time in documenting a workflow and how to document it.
* New user workflow
* Significant UI redesign
* Multi-screen interaction
* New email or notification flow
* Complex state changes that are easier to understand visually
- Add the "Documenting Your Design Work in GitHub Issue Comments" to the wiki as well (see below for content)
Edit design issue template
- Contains a lot of references to design team leads which are artifacts from last July
- Needs to be clearer on the order of presenting work to product/design lead
- Needs to work when there is and isn't a design lead
### Action Items
- [ ] Find all design wiki pages and copy each to a markdown file٭
- [ ] Review and edit all related wiki pages
- [ ] Edit design issue template to simplify and point to appropriate place in wiki
- [ ] Review with designers. Update if needed based on feedback
- [ ] Commit new template
- [ ] Update all open design issue checkboxes to match new design issue template
### Resources/Instructions
- https://github.com/hackforla/tdm-calculator/issues/new?template=design-issue.md
- https://github.com/hackforla/tdm-calculator/wiki/Design
- https://github.com/hackforla/tdm-calculator/blob/develop/.github/ISSUE_TEMPLATE/design-issue.md
#### Files and Folders
- [TDM Designer Wiki - .md files](https://drive.google.com/drive/folders/1TmKSSV8blbTnF-vCLNE9vRGq6pcx5U3Y)
٭there was a formatting issue in the following files and some characters were replaced with `?`
- design-issue-workflow.md
- design-submissions.md
#### Staging and Release decks
- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/)
- [Staging slide, ISSUE NUMBER]
- Release Deck
- [2025-MM-DD Release deck, slide ISSUE NUMBER]
Contributor guide
Research direction
Start by reviewing the Design wiki and .github/ISSUE_TEMPLATE/design-issue.md, then compare the source files design-issue-workflow.md and design-submissions.md. Update the wiki guidance and template, incorporate designer feedback, and update open design issue checkboxes so they match the new template.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- design, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100