microsoft/CSS-Exchange

[Work Item] Create a Shared Function(s) for displaying object in a common format to avoid lots of lines of code/code changes

Open

#1,773 opened on Jul 21, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)PowerShell (234 forks)batch import
Work Itemgood first issue

Repository metrics

Stars
 (985 stars)
PR merge metrics
 (Avg merge 5d 1h) (15 merged PRs in 30d)

Description

Describe the work Would like to move and create more functions similar to this:

https://github.com/microsoft/CSS-Exchange/blob/fc8b7ada30c101a5bda0d07c1ba66262d7d91356/Search/Troubleshoot-ModernSearch/Write/WriteHelpers.ps1

This will help the display of object a little bit better and avoid formatting issues like this:

image

Where adding a color code format to the object being displayed required multiple lines to be adjusted and if we add another attribute to the object that is longer, we have to then adjust all the lines as well to keep the same formatting.

Contributor guide

Research direction
Examine the linked file at https://github.com/microsoft/CSS Exchange/blob/fc8b7ada30c101a5bda0d07c1ba66262d7d91356/Search/Troubleshoot ModernSearch/Write/WriteHelpers.ps1 to understand the existing shared function pattern. Identify commonly used object display code throughout the repo that could be refactored into a reusable function. The goal is to reduce code duplication and formatting issues as described in the issue. No additional comments or PRs exist, so the first step is to analyze the function and propose a generalized version.
Tech stack
shell
Domain
developer experience
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
PowerShell scripting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70