From b50df83b3c05981ba768298dad53a8dd4b99034c Mon Sep 17 00:00:00 2001 From: Ben Howell Date: Mon, 31 Oct 2022 16:33:09 -0700 Subject: [PATCH 1/5] Update convergence epic template --- .github/ISSUE_TEMPLATE/convergence_epic.md | 61 ++++++++++++---------- 1 file changed, 32 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/convergence_epic.md b/.github/ISSUE_TEMPLATE/convergence_epic.md index ca5b1b2522ffe..ee55b0587473f 100644 --- a/.github/ISSUE_TEMPLATE/convergence_epic.md +++ b/.github/ISSUE_TEMPLATE/convergence_epic.md @@ -1,48 +1,51 @@ --- -name: (internal) Component convergence epic -about: (team member use only) Epic issue tracking convergence of a particular component +name: (internal) Component implementation epic +about: (team member use only) Epic issue tracking implementation of a particular component --- -## Preparation: +https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide -- [ ] Open UI Research +## Preparation + +- [ ] [Open UI Research](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#open-ui-research) - [link to https://open-ui.org/] -- [ ] Open GitHub issues related to component +- [ ] [Open GitHub issues related to component](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#find-open-issues-on-github) - [link to each issue] -- [ ] react-\* package scaffolded with the right ownership in CODEOWNERS - - [link to package / PR] -- [ ] Component Spec authored and reviewed +- [ ] [Create react-\* package and component from template](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#component-package) + - [link to PR] + - [link to package: `https://github.com/microsoft/fluentui/tree/master/packages/react-components/react-`] +- [ ] (Optional) [Draft implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#draft-implementation) + - [link to PR, if applicable] +- [ ] [Component Spec authored and reviewed](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#component-spec) - [link to spec in component package / PR] -## Implementation - -[link to react-* package folder] +## Implementation and release to unstable - [ ] Component implementation - [link(s) to component implementation related PRs] -- [ ] Storybook stories - - [link(s) to stories PRs] -- [ ] Add tests: Conformance, Unit, and VR -- add PRs to all - - [ ] Bundle size fixtures - - [ ] Conformance tests - - [ ] Unit tests - - [ ] VR tests - - [ ] Accessibility behavior tests +- [ ] Add initial unit tests (validate basic functionality) +- [ ] Initial documentation + - [ ] Storybook stories + - [ ] README.md covering basic usage + - [ ] MIGRATION.md guide (include v8 and v0) +- [ ] Component exported from `@fluentui/react-components/unstable` + - [link to PR] + +## Stable release + +- [ ] Add tests + - [ ] Bundle size fixtures ([link to PR]) + - [ ] Conformance tests ([link to PR]) + - [ ] Unit tests ([link to PR]) + - [ ] VR tests ([link to PR]) + - [ ] Accessibility behavior tests ([link to PR]) - [ ] Create an issue and run [manual accessibility tests](https://github.com/microsoft/fluentui/wiki/Manual-Accessibility-Review-Checklist): (issue link) - - [ ] Performance test scenario -- [ ] README.md covering basic usage -- [ ] MIGRATION.md guide (include v8 and v0) - -## Validation - -- [ ] Add and validate in UI Builder -- [ ] Add and validate in docs site -- [ ] Validate with token pipeline + - [ ] Performance test scenario ([link to PR]) - [ ] Validate in product - [ ] Finalize migration guide - [ ] Author codemods From d37ac7b6e8ad63cdf8d6bd6b103da1ab8c213ff2 Mon Sep 17 00:00:00 2001 From: Ben Howell Date: Tue, 1 Nov 2022 17:00:17 -0700 Subject: [PATCH 2/5] Update convergence epic --- .github/ISSUE_TEMPLATE/convergence_epic.md | 42 ++++++++++++---------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/convergence_epic.md b/.github/ISSUE_TEMPLATE/convergence_epic.md index ee55b0587473f..1df0c090fb52e 100644 --- a/.github/ISSUE_TEMPLATE/convergence_epic.md +++ b/.github/ISSUE_TEMPLATE/convergence_epic.md @@ -8,8 +8,6 @@ These issues are used by core contributors to track the list of items that shoul completed as part of creating a v9 component. More info can be found here: https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide --> -https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide - ## Preparation - [ ] [Open UI Research](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#open-ui-research) @@ -21,16 +19,17 @@ https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide - [link to package: `https://github.com/microsoft/fluentui/tree/master/packages/react-components/react-`] - [ ] (Optional) [Draft implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#draft-implementation) - [link to PR, if applicable] -- [ ] [Component Spec authored and reviewed](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#component-spec) - - [link to spec in component package / PR] +- [ ] [Component Spec authored](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#component-spec) and [reviewed](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#spec-review) + - [link to PR] + - [link to Spec.md: `https://github.com/microsoft/fluentui/tree/master/packages/react-components/react-/Spec.md`] ## Implementation and release to unstable -- [ ] Component implementation +- [ ] [Component implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#implement-the-control) - [link(s) to component implementation related PRs] -- [ ] Add initial unit tests (validate basic functionality) -- [ ] Initial documentation - - [ ] Storybook stories +- [ ] Initial conformance and unit tests (validate basic functionality) +- [ ] [Initial documentation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#documentation) + - [ ] [Storybook stories](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#storybook-stories) - [ ] README.md covering basic usage - [ ] MIGRATION.md guide (include v8 and v0) - [ ] Component exported from `@fluentui/react-components/unstable` @@ -38,14 +37,19 @@ https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide ## Stable release -- [ ] Add tests - - [ ] Bundle size fixtures ([link to PR]) - - [ ] Conformance tests ([link to PR]) - - [ ] Unit tests ([link to PR]) - - [ ] VR tests ([link to PR]) - - [ ] Accessibility behavior tests ([link to PR]) - - [ ] Create an issue and run [manual accessibility tests](https://github.com/microsoft/fluentui/wiki/Manual-Accessibility-Review-Checklist): (issue link) - - [ ] Performance test scenario ([link to PR]) -- [ ] Validate in product -- [ ] Finalize migration guide - - [ ] Author codemods +- [ ] [Add tests](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#tests) + - [ ] Unit and conformance tests + - [ ] VR tests + - [ ] Bundle size fixtures + - [ ] Performance test scenario + - [ ] Accessibility behavior tests + - [ ] Create an issue and run [manual accessibility tests](https://github.com/microsoft/fluentui/wiki/Manual-Accessibility-Review-Checklist): [link to issue] + - [Link to PR(s)] +- [ ] [Validate in product](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#validation) +- [ ] Finalize documentation + - [ ] Review and add any missing storybook stories + - [ ] Finalize migration guide +- [ ] [Component released as stable](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#stable-release) from `@fluentui/react-components` + - [ ] Ensure exports are removed from from `@fluentui/react-components/unstable` + - [ ] In package.json: Remove the alpha/beta tag from the version number in package.json + - [ ] In package.json: Change beachball's `disallowedChangeTypes` to `"major", "prerelease"` From 7672109691ab25492e37b4796f828edc647cf9a8 Mon Sep 17 00:00:00 2001 From: Ben Howell Date: Tue, 1 Nov 2022 17:09:52 -0700 Subject: [PATCH 3/5] Change headings --- .github/ISSUE_TEMPLATE/convergence_epic.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/convergence_epic.md b/.github/ISSUE_TEMPLATE/convergence_epic.md index 1df0c090fb52e..fd6cda5e77b30 100644 --- a/.github/ISSUE_TEMPLATE/convergence_epic.md +++ b/.github/ISSUE_TEMPLATE/convergence_epic.md @@ -23,7 +23,7 @@ completed as part of creating a v9 component. More info can be found here: https - [link to PR] - [link to Spec.md: `https://github.com/microsoft/fluentui/tree/master/packages/react-components/react-/Spec.md`] -## Implementation and release to unstable +## Implementation - [ ] [Component implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#implement-the-control) - [link(s) to component implementation related PRs] @@ -35,7 +35,7 @@ completed as part of creating a v9 component. More info can be found here: https - [ ] Component exported from `@fluentui/react-components/unstable` - [link to PR] -## Stable release +## Validation - [ ] [Add tests](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#tests) - [ ] Unit and conformance tests From 937f8e9037520a6221b85840a954a008dd9281d6 Mon Sep 17 00:00:00 2001 From: Ben Howell <48106640+behowell@users.noreply.github.com> Date: Wed, 2 Nov 2022 10:10:04 -0700 Subject: [PATCH 4/5] Fix links --- .github/ISSUE_TEMPLATE/convergence_epic.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/convergence_epic.md b/.github/ISSUE_TEMPLATE/convergence_epic.md index fd6cda5e77b30..41bad8ced5007 100644 --- a/.github/ISSUE_TEMPLATE/convergence_epic.md +++ b/.github/ISSUE_TEMPLATE/convergence_epic.md @@ -25,14 +25,14 @@ completed as part of creating a v9 component. More info can be found here: https ## Implementation -- [ ] [Component implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#implement-the-control) +- [ ] [Component implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#implementation) - [link(s) to component implementation related PRs] - [ ] Initial conformance and unit tests (validate basic functionality) - [ ] [Initial documentation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#documentation) - [ ] [Storybook stories](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#storybook-stories) - [ ] README.md covering basic usage - [ ] MIGRATION.md guide (include v8 and v0) -- [ ] Component exported from `@fluentui/react-components/unstable` +- [ ] [Component released as unstable](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#unstable-release) from `@fluentui/react-components/unstable` - [link to PR] ## Validation @@ -46,7 +46,7 @@ completed as part of creating a v9 component. More info can be found here: https - [ ] Create an issue and run [manual accessibility tests](https://github.com/microsoft/fluentui/wiki/Manual-Accessibility-Review-Checklist): [link to issue] - [Link to PR(s)] - [ ] [Validate in product](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#validation) -- [ ] Finalize documentation +- [ ] [Finalize documentation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#finalize-documentation) - [ ] Review and add any missing storybook stories - [ ] Finalize migration guide - [ ] [Component released as stable](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#stable-release) from `@fluentui/react-components` From e4b5ebbaf013d2a5cac9af2814111e8141f8295d Mon Sep 17 00:00:00 2001 From: Ben Howell Date: Wed, 9 Nov 2022 15:48:28 -0800 Subject: [PATCH 5/5] Updates from PR feedback --- .github/ISSUE_TEMPLATE/convergence_epic.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/convergence_epic.md b/.github/ISSUE_TEMPLATE/convergence_epic.md index fd6cda5e77b30..afca28c2a02aa 100644 --- a/.github/ISSUE_TEMPLATE/convergence_epic.md +++ b/.github/ISSUE_TEMPLATE/convergence_epic.md @@ -8,6 +8,8 @@ These issues are used by core contributors to track the list of items that shoul completed as part of creating a v9 component. More info can be found here: https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide --> +💡 When you create a PR for any of the checklist items, add a link to this Epic under the PR's **Related Issues** section. + ## Preparation - [ ] [Open UI Research](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#open-ui-research) @@ -15,25 +17,20 @@ completed as part of creating a v9 component. More info can be found here: https - [ ] [Open GitHub issues related to component](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#find-open-issues-on-github) - [link to each issue] - [ ] [Create react-\* package and component from template](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#component-package) - - [link to PR] - - [link to package: `https://github.com/microsoft/fluentui/tree/master/packages/react-components/react-`] + - [link to package: https://github.com/microsoft/fluentui/tree/master/packages/react-components/react-(your-component)] - [ ] (Optional) [Draft implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#draft-implementation) - - [link to PR, if applicable] + - [link to draft implementation, if applicable] - [ ] [Component Spec authored](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#component-spec) and [reviewed](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#spec-review) - - [link to PR] - - [link to Spec.md: `https://github.com/microsoft/fluentui/tree/master/packages/react-components/react-/Spec.md`] ## Implementation - [ ] [Component implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#implement-the-control) - - [link(s) to component implementation related PRs] - [ ] Initial conformance and unit tests (validate basic functionality) - [ ] [Initial documentation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#documentation) - [ ] [Storybook stories](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#storybook-stories) - [ ] README.md covering basic usage - [ ] MIGRATION.md guide (include v8 and v0) - [ ] Component exported from `@fluentui/react-components/unstable` - - [link to PR] ## Validation @@ -44,8 +41,7 @@ completed as part of creating a v9 component. More info can be found here: https - [ ] Performance test scenario - [ ] Accessibility behavior tests - [ ] Create an issue and run [manual accessibility tests](https://github.com/microsoft/fluentui/wiki/Manual-Accessibility-Review-Checklist): [link to issue] - - [Link to PR(s)] -- [ ] [Validate in product](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#validation) +- [ ] [Validate with partners](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#validation) - [ ] Finalize documentation - [ ] Review and add any missing storybook stories - [ ] Finalize migration guide