Skip to content

Commit

Permalink
Merge branch 'main' into bug/274-roettger-LinkComponentIconOverrideIs…
Browse files Browse the repository at this point in the history 
…sues
  • Loading branch information
@TimRoe
TimRoe authored Apr 4, 2024
2 parents 6949254 + 9ec578a commit 6f62d20
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 275 deletions.
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/contributing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name: Contributing to the design system
about: Template for new common component for VA mobile app
title: 'Component: [Insert name of component here]'
labels: component-documentation, ux
assignees:
labels: ux
assignees: ''

---

# Contributing to the design system
Expand Down Expand Up @@ -37,4 +38,4 @@ Include any research you have already conducted, or plan to conduct, on this com
Include any existing code.

## Next steps
After filling out the issue template, post in the Design System slack channel to alert the team that you have filled out an issue. The team will reach out to you with any questions, feedback, and next steps.
After filling out the issue template, post in the Design System slack channel to alert the team that you have filled out an issue. The team will reach out to you with any questions, feedback, and next steps.
270 changes: 4 additions & 266 deletions .github/ISSUE_TEMPLATE/epic-ticket.md
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
---
name: Epic Ticket
about: Template for Mobile Design System Epics
title: "[Epic Title]"
title: DS - [Epic Title]
labels: design-system, epic
assignees: kellylein

---

<!-- Please fill out all of the relevant sections of this template. Please do not delete any areas of this template. The tickets can be updated as the sections are finished and any section that doesn't need to have info should be labeled as NA -->


# Project Status Overview

### Project Objective:

- High level description of the project and what we are trying to solve


### Product Brief:
- [link to GitHub Product Brief]

### Current Dependencies / Blockers
<details>
<summary>Blockers</summary>
Expand All @@ -30,23 +29,6 @@ assignees: kellylein

</details>


### Project Timeline
<details>
<summary>Milestones</summary>

|Step | Timing |
|-------| ---------|
|Sprint 0 - Discovery | |
|Step 1 - Strategy | |
|Step 2 - Design | |
|Step 3 - Building / Implementing | |
| 100% Release | |
|Step 4 - Post Verification| |
</details>



### Monthly Update for Stakeholders
<details>
<summary>Updates</summary>
Expand All @@ -59,90 +41,6 @@ assignees: kellylein
|Month Year|
</details>

# Detailed Project Scope

### Problem Statement

### Current Veteran Experience
<details>
<summary>What the Veteran experiences today and its painpoints</summary>

**Veteran Experience**

**Veteran Painpoints**

</details>

### Assumptions

<details>
<summary>Assumptions that need to be true for this project</summary>

1.)

2.)

3.)


</details>

### Risks

<details>
<summary>Risks identified and accepted by stakeholders</summary>

1.)

2.)

3.)


</details>

### Definition of Done
<details>
<summary>Conditions that must be true in order to consider this project completed</summary>

|Item | Completed |
|-------| ---------|
| | |
| | |

</details>

### Project Scope
<details>
<summary>Items in and out of scope</summary>

|In Scope | Out of Scope|
|-------| ---------|
| | |
| | |

</details>

### Important Project Links
<details>
<summary>Links</summary>

- Github Epic
- Github VA Mobile Page
- - Product Brief
- Product Canvas
- Design
- Discovery
- Mockups
- Final Design
- Figma File
- Research
- Research Plan
- Research Results and Findings
-Analytics
-Decision Log
</details>

### Team Members

<details>
Expand All @@ -166,164 +64,4 @@ assignees: kellylein
- **Mobile Teams that are involved:** Global, Health and Benefits, Design System, QA, API


</details>

### OKR and Analytic Metrics
<details>
<summary>Analytic Information </summary>

**What KPIs / OKRS are the focus of this project?**

1.)

2.)

**The link to the project's analytical dashboard**



|What we are measuring | Why | How / Event Name |
|-------| ---------| ----- |
| How will we determine this is a success? | | |
| How will we determine if this is not a success? | | |

|Analytic Event| What is it measuring | How to use it to measure |
|-------| ---------| ----- |
| | |
| | |

</details>


### Questions
<details>
<summary>Open Questions</summary>

- How are we measuring success?

- What is MVP and what is out of scope?

- Has there been existing research or work done on this project before?

- Is this work being done within the VA today (ex. web)

</details>

<details>
<summary>Closed Questions</summary>

| Question | Answer | Owner |
|--------|----------|------|
| | | |
| | | |

</details>

### Change / Decision Log

Product will need to create on in the Github folder and link it here.


# Checklist

<details>
<summary>Toggle Product Checklist</summary>

**Project Kickoff & Requirements Gathering**
- [ ] PM to create new Github epic and fill out accordingly (Type - Epic, Template - Epic Ticket
- [ ] Updated so it is seen in Mobile and External Github Boards - may need to view this epic in Github and not Zenhub
- [ ] PM to create new Github folder for feature or update existing
- [ ] Create a separate document for the project's decision log - link it here
- [ ] Project Kickoff session to review problem statement, Veteran experience, and goals with stakeholders
- [ ] Determine team roles, responsibilities, approvers with stakeholders
- [ ] Determine future cadance reviews with stakeholders
- [ ] Review dependencies
- [ ] Scope finalized or approved by Mobile POs
- [ ] PM to create and/ or link Product Brief
- [ ] Design work to update hi-res internal files
- [ ] Engineering created successful unit tests
- [ ] UX has completed visual QA
- [ ] Accessibility testing has been completed
- [ ] PM fills out and completes Epic's checklists
- [ ] Other:

</details>


<details>
<summary>Toggle Design/UX Checklist</summary>

- [ ] If QA testing needed, coordinate with QA agent and assign QA agent to the ticket
- [ ] Review problem/opportunity statement
- [ ] Add questions and assumptions to product brief
- [ ] Add research links to product brief
- [ ] Document high-level research/design plans
- [ ] Create lo/hi fi wireframes & user flows if applicable
- [ ] Add links to Epic & applicable GitHub folders
- [ ] Socialize designs
- [ ] Sign off received on finalized design - link to approval
- [ ] Design QA / Visual QA approval
- [ ] If QA testing needed, coordinate with QA agent
- [ ] Component review
- [ ] Accessibility review
- [ ] Design system review
- [ ] Update internal documents
- [ ] Other:

</details>

<details>
<summary>Toggle Content Checklist</summary>

- [ ] If QA testing needed, coordinate with QA agent and assign QA agent to the ticket
- [ ] Review product brief and surface any questions, assumptions & risks
- [ ] Participate in project discovery and kickoff activities/ceremonies
- [ ] Complete comparative analysis/content research activities for net-new content
- [ ] Review current content and determine where app may need to differ and potential improvements to share with web
- [ ] Review past VA research and decisions documentation
- [ ] Support Research & UX Design in research sessions and synthesis
- [ ] Make content recommendations for lo-/hi-fi wireframes in collaboration with UX Design
- [ ] Collaborate with Sitewide Content team for alignment, improvements, and sign-off
- [ ] Participate in FE hand off
- [ ] Complete content QA
- [ ] Other:

</details>

<details>
<summary>Toggle Engineering Checklist</summary>

- [ ] If QA testing needed, coordinate with QA agent and assign QA agent to the ticket
- [ ] Are UI designs/ specs available/ready? If yes, they should be attached to attach specs. (We are assuming the design specs have been approved)
- [ ] Are there any deadlines that need to be met?
- [ ] Do we want to capture analytics for this projects (i.e. update GA, add logs to grafana/datadog etc)?If yes, what metrics would we like to capture?
- [ ] Other:

</details>

<details>
<summary>Toggle QA Checklist</summary>

- [ ] Team PM creates test plan and assigns to Team QA agent- Template: QA Test Plan
- [ ] QA agent to monitor and speak up on QA needs for the project
- [ ] Document decision in the descision log regarding QA
- [ ] Identify test data needs
- [ ] Determine and document test accounts used
- [ ] Test plan creation and resolution
- [ ] Successful testing on all MVP tickets
- [ ] Reviews open bug tickets pre-production
- [ ] Other:

</details>

<details>
<summary>Analytics Checklist</summary>

- [ ] Discussion on what can and can't be measured pre-design
- [ ] Determine what analytics work is included in for MVP
- [ ] Document non-mvp analytic needs in Github
- [ ] Update Analytics section of this epic
- [ ] Determine if analytics can be tested by QA - if so coordinate with QA
- [ ] Other:

</details>
11 changes: 6 additions & 5 deletions .github/pull_request_template.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<!-- PR title naming convention:
'[Issue type] Brief summary of issue suitable for changelog or copy/paste issue title',
where Issue type = bug, feature, spike, CU (code upkeep), etc.-->
Expand All @@ -7,28 +6,29 @@ where Issue type = bug, feature, spike, CU (code upkeep), etc.-->
'[Issue type]/[Issue #]-[Your name]-[Summary of issue]',
where Issue type = bug, feature, spike, CU (code upkeep), etc.-->

<!-- Update w/ ticket number to cross-repo link PR and ticket; ZenHub URL does not work -->
**[Ticket # ](https://github.com/department-of-veterans-affairs/va-mobile-app/issues/# )**

## Description of Change
<!-- Describe the change and context with which it was made beyond ACs unless straightforward.
Consider:
- What is relevant to code reviewer(s) and not in the ticket?
- What context may be relevant to a future dev or you in 6 months about this PR?
- Did the course of work lead to notable dead ends? If so, why didn't they pan out?
- Did the change add new dependencies? Why?
- Were there important sources to link? Examples: an open bug with a dependency project, an article of someone else solving the same problem that was partially or wholly copied, external documentation relevant to solution -->
- Were there important sources to link? Examples: an open bug with a dependency project, an article of someone else solving the same problem that was partially or wholly copied, external documentation relevant to solution
-->


#### Testing Packages
<!-- List or range of alpha/beta packages published in association with this PR, if any -->


### Screenshots/Video
<!-- Add screenshots or video as needed; before/after recommended if appropriate.
Convenience side-by-side formatting:
Before/after: <img src="" width="49%" />&nbsp;&nbsp;<img src="" width="49%" />
Accordion before/after: <details><summary>Before/after</summary><img src="" width="49%" />&nbsp;&nbsp;<img src="" width="49%" /></details>
-->


## Testing
<!-- Describe testing conducted to validate changes.
Consider highlighting:
Expand Down Expand Up @@ -61,4 +61,5 @@ Code reviewer validation:
If changes warrant a new version [per the versioning guidelines](https://github.com/department-of-veterans-affairs/va-mobile-library#versioning-policy) and the PR is approved and ready to merge:
- [ ] Merge `main` into branch
- [ ] Merge branch to `main`
- [ ] Verify that [Check Component Integrations](https://github.com/department-of-veterans-affairs/va-mobile-library/actions/workflows/check-component-integrations.yml) workflow ran successfully
- [ ] [Publish new version](https://github.com/department-of-veterans-affairs/va-mobile-library/actions/workflows/publish.yml) after merging
1 change: 0 additions & 1 deletion packages/components/tsconfig.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
// "module": "" /* Specify what module code is generated. */,
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "" /* Specify how TypeScript looks up a file from a given module specifier. */,
"baseUrl": "src" /* Specify the base directory to resolve non-relative module names. */,
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
Expand Down

0 comments on commit 6f62d20

Please sign in to comment.