-
Notifications
You must be signed in to change notification settings - Fork 2.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Component Implementation Epic template #25480
Merged
behowell
merged 9 commits into
microsoft:master
from
behowell:convergence-epic-template
Nov 10, 2022
Merged
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
b50df83
Update convergence epic template
behowell d37ac7b
Update convergence epic
behowell 7672109
Change headings
behowell 937f8e9
Fix links
behowell 3f3422e
Merge branch 'master' of https://github.com/microsoft/fluentui into c…
behowell e4b5ebb
Updates from PR feedback
behowell 11ef83d
Merge branch 'convergence-epic-template' of https://github.com/behowe…
behowell f8e3ebb
Merge branch 'master' of https://github.com/microsoft/fluentui into c…
behowell 191670a
Merge branch 'master' of https://github.com/microsoft/fluentui into c…
behowell File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,55 @@ | ||
| --- | ||
| 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: | ||
| ## Preparation | ||
|
|
||
| - [ ] Open UI Research | ||
| - [ ] [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 PR] | ||
| - [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] | ||
| - [ ] [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-<your-component>/Spec.md`] | ||
|
|
||
| ## Implementation | ||
|
|
||
| [link to react-* package folder] | ||
|
|
||
| - [ ] Component implementation | ||
| - [ ] [Component implementation](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#implementation) | ||
| - [link(s) to component implementation related PRs] | ||
behowell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] 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) | ||
| - [ ] 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` | ||
| - [link to PR] | ||
|
|
||
| ## 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] | ||
| - [Link to PR(s)] | ||
behowell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] [Validate in product](https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#validation) | ||
behowell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] [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"` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GeoffCox had a good idea about a codesandbox template for the Draft Implementation. Don't have to block on this, but I wanted to mention him so he saw this as a good place to put the link/idea bout the template
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good idea! I don't think this issue tempalte needs to mention the details specifically, but @GeoffCox it would be great to add details about that to the wiki article linked from here: https://github.com/microsoft/fluentui/wiki/Component-Implementation-Guide#draft-implementation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess my main feedback here would be to actually encourage folks to use a CodeSandbox instead of a PR. So this:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'll make it more generic of "link to draft implementation, if applicable". That way, people can implement the draft in whatever way makes the most sense to them. I think it's worthwhile updating the wiki article to suggest using CodeSandbox, but it's better to leave it unspecified in the epic issue. Does that sound good?