You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,6 @@ Figma file: [if it applies]
23
23
### 👀 Component checklist
24
24
25
25
-[ ] Percy was checked for any visual regression
26
-
-[ ] A changelog entry was added via [Changesets](https://github.com/changesets/changesets) if needed (see [templates here](https://github.com/hashicorp/design-system/blob/main/wiki/Website-Changelog.md#templates-for-npm-packages))
26
+
-[ ] A changelog entry was added via [Changesets](https://github.com/changesets/changesets) if needed (see [templates here](https://hashicorp.atlassian.net/wiki/spaces/HDS/pages/3243114706/Changelog+authoring+best+practices#Templates))
27
27
28
28
:speech_balloon: Please consider using [conventional comments](https://conventionalcomments.org/) when reviewing this PR.
Copy file name to clipboardExpand all lines: .github/workflows/open-pull-request-for-icon-update.yml
+1-1
Original file line number
Diff line number
Diff line change
@@ -75,6 +75,6 @@ jobs:
75
75
76
76
### 👀 Component checklist
77
77
78
-
- [ ] A changelog entry was added via [Changesets](https://github.com/changesets/changesets) if needed ([instructions here](https://github.com/hashicorp/design-system/blob/main/packages/flight-icons/CONTRIBUTING.md#updating-the-icons-in-flight-icons) / [expected format here](https://github.com/hashicorp/design-system/blob/main/wiki/Website-Changelog.md#new-icons))
78
+
- [ ] A changelog entry was added via [Changesets](https://github.com/changesets/changesets) if needed ([instructions here](https://github.com/hashicorp/design-system/blob/main/packages/flight-icons/CONTRIBUTING.md#updating-the-icons-in-flight-icons) / [expected format here](https://hashicorp.atlassian.net/wiki/spaces/HDS/pages/3243114706/Changelog+authoring+best+practices#New-icons))
Copy file name to clipboardExpand all lines: packages/components/NEW-COMPONENT-CHECKLIST.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ The following should be available as resources for the Project Kickoff.
11
11
12
12
## Project Kickoff
13
13
14
-
A project kickoff will be scheduled before the project start date. The kickoff will be used to align on project scope, timelines, and milestones and as a space to discuss any open questions. In attendance should be Design System team leadership, lead Designer and Engineer on the project, and Design/Engineer buddies (if applicable).
14
+
A project kickoff will be scheduled before the project start date. The kickoff will be used to align on project scope, timelines, and milestones and as a space to discuss any open questions. In attendance should be Design System team leadership, lead Designer and Engineer on the project, and Design/Engineer buddies (if applicable).
15
15
16
16
## Design Checklist
17
17
The design checklist has 4 primary parts:
@@ -31,18 +31,18 @@ The design process is largely cyclical, so some steps may be repeated until fina
31
31
-[ ] change "{Component name}" to the name of the component
32
32
-[ ] delete the figma tips frame, if not needed
33
33
-[ ] design and build the component, taking into account existing [foundations](https://www.figma.com/file/oQsMzMMnynfPWpMEt91OpH/HDS-Product---Foundations?node-id=2916%3A4) and patterns, as well as the findings from the audit and requirements from the CRD
34
-
- artifacts should include:
34
+
- artifacts should include:
35
35
- component explorations
36
36
- examples in context
37
37
- built component
38
38
-[ ] review with situationally appropriate stakeholders and iterate
39
-
- reviewers should include:
39
+
- reviewers should include:
40
40
- HDS designers and manager
41
41
- engineering partner(s)
42
42
- a11y SME
43
43
- other external stakeholders as defined during the kickoff
44
44
- consider also including any key stakeholders
45
-
- reviews should include checks for:
45
+
- reviews should include checks for:
46
46
- alignment to Helios design vision
47
47
- ux solution
48
48
- fulfillment of requirements from the audit and CRD
@@ -57,7 +57,7 @@ The design process is largely cyclical, so some steps may be repeated until fina
57
57
-[ ] request a final branch review from HDS designers
58
58
-[ ] sync with your engineering partner
59
59
- let them know it's been approved and answer any remaining questions
60
-
60
+
61
61
### Component Testing
62
62
-[ ] prepare for testing
63
63
-[ ] lock the components
@@ -70,14 +70,14 @@ The design process is largely cyclical, so some steps may be repeated until fina
70
70
-[ ] ask key stakeholders to test the component
71
71
- depending on the complexity, we usually give them 3-4 days to complete the testing
72
72
-[ ] if iterations are needed, work through the process until approved (don't forget to branch!)
73
-
73
+
74
74
### Documentation
75
75
-[ ] while the component is being tested, write the documentation
76
76
- artifacts should include:
77
77
- design guidelines
78
78
- specifications
79
79
- relevant accessibility details
80
-
80
+
81
81
### Release in Figma
82
82
Once key stakeholders have tested the component and iterations are approved, prepare for a final release of the component.
83
83
@@ -164,4 +164,4 @@ When ready for review:
164
164
165
165
-[ ] add situationally appropriate reviewers
166
166
-[ ] add instructions for reviewers in your PR, letting them know what kind of review you need
167
-
-[ ] add a changelog update via [Changesets](https://github.com/changesets/changesets) if needed using the command `yarn changeset` (in the project root) using the [predefined format](https://github.com/hashicorp/design-system/blob/main/wiki/Website-Changelog.md#templates-for-npm-packages))
167
+
-[ ] add a changelog update via [Changesets](https://github.com/changesets/changesets) if needed using the command `yarn changeset` (in the project root) using the [predefined format](https://hashicorp.atlassian.net/wiki/spaces/HDS/pages/3243114706/Changelog+authoring+best+practices#Templates))
0 commit comments