OfficeDev/microsoft-teams-ui-component-library

Component naming

Open

#2 opened on Oct 1, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (33 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (127 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently components with names like Toolbar exist in both Fluent UI and as a "high-value" component for Teams.

Will developers benefit from working with different names, or should naming overlap intentionally?

Furthermore, what are our conventions around component names that are more than one word, i.e. how will we disambiguate between a part of a high-value component and an unrelated first-class high-value component, e.g. between "task board" and a hypothetical component called "board", given patterns like Table (an HVC) and TableRow (a special component of Table) are accepted?

Contributor guide

Research direction
Review existing component naming conventions in Fluent UI and Teams codebase, and propose a consistent naming strategy for high value components.
Tech stack
typescriptreact
Domain
frontend
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70