mattermost-community/focalboard

Code Debt: Share common code between Person and MultiPerson properties

Open

#4842 opened on Sep 30, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (26,187 stars) (2,542 forks)user submission
EnhancementHacktoberfestHelp WantedUp for grabs

Description

Summary

The Person Property and MultiPerson Property share most of the same code.

Especially after this PR made them work in an equivalent manner. We should implement a "base Person property" and update Person and MultiPerson to call this property with its specific needs.

How important this is to me and why

Importance: High

As a sameple, see how the various text properties (Text, Email, Phone, and Number) use BaseTextEditor.

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactTypeScriptFocalboard codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the files `webapp/src/properties/person/person.tsx` and `webapp/src/properties/multiperson/multiperson.tsx` to understand their shared logic. Review PR #3888 which made them equivalent. Create a base component similar to `BaseTextEditor` and refactor both properties to extend it. Ensure that the refactored components pass existing tests and maintain functionality.