microsoft / microsoft/fluentui

[Feature]: Create style guide for writing v9 components

Open
#29,779 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Fluent UI react-components (v9) Package: docs Resolution: Soft Close Type: Feature
Dominant language
TypeScript
Stars
20.3k
Forks
2.9k
Avg merge
2d 9h
Merged PRs (30d)
46

Description

Library

React Components / v9 (@fluentui/react-components)

Describe the feature that you would like added

Based on discussion in https://github.com/microsoft/fluentui/pull/29360#discussion_r1345756919.

We have style on how to write styles aka Styles Handbook (https://github.com/microsoft/fluentui/blob/master/rfcs/react-components/styles-handbook.md). We need to provide the same level of guidance for writing Fluent components to enforce best practices and avoid their violations.

Have you discussed this feature with our team

@Hotell

Additional context

No response

Validations
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
Priority

Normal

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the discussion in pull request 29360 and compare the existing rfcs/react-components/styles-handbook.md with the guidance this issue requests. Define the scope and structure for a component-writing guide, then consider it done when equivalent, agreed-upon best-practice documentation for Fluent v9 components is published.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation, frontend
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.