forked from microsoft/fluentui
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Component Implementation Epic template (microsoft#25480)
- Loading branch information
Showing
1 changed file
with
35 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| --- | ||
|
|
||
| <!-- | ||
| These issues are used by core contributors to track the list of items that should be | ||
| completed as part of converging a component. More info can be found here: https://github.com/microsoft/fluentui/wiki/Component-Convergence-Guide | ||
| completed as part of creating a v9 component. More info can be found here: https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide | ||
| --> | ||
|
|
||
| ## Preparation: | ||
| 💡 When you create a PR for any of the checklist items, add a link to this Epic under the PR's **Related Issues** section. | ||
|
|
||
| - [ ] 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 | ||
| - [link to spec in component package / PR] | ||
| - [ ] [Create react-\* package and component from template](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#component-package) | ||
| - [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 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) | ||
|
|
||
| ## Implementation | ||
|
|
||
| [link to react-* package folder] | ||
|
|
||
| - [ ] 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 | ||
| - [ ] 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) | ||
| - [ ] [Component implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#implementation) | ||
| - [ ] 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 released as unstable](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#unstable-release) from `@fluentui/react-components/unstable` | ||
|
|
||
| ## Validation | ||
|
|
||
| - [ ] Add and validate in UI Builder | ||
| - [ ] Add and validate in docs site | ||
| - [ ] Validate with token pipeline | ||
| - [ ] 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] | ||
| - [ ] [Validate with partners](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#validation) | ||
| - [ ] [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` | ||
| - [ ] 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"` |