Skip to content

Simplify color documentation to reference helper functions#6564

Merged
kristenwomack merged 2 commits intoupdate-contribution-guidelinesfrom
copilot/sub-pr-6420
Jan 21, 2026
Merged

Simplify color documentation to reference helper functions#6564
kristenwomack merged 2 commits intoupdate-contribution-guidelinesfrom
copilot/sub-pr-6420

Conversation

Copy link
Contributor

Copilot AI commented Jan 21, 2026

The CLI Color Standards section contained extensive ANSI color code tables that distracted from the established helper functions in cli/azd/pkg/output/colors.go.

Changes

  • Replaced ANSI tables with helper function reference: Main section now features a table of all color helper functions (WithSuccessFormat, WithErrorFormat, etc.) with clear purpose mappings
  • Updated code examples: Changed from raw ANSI escape codes to helper function usage patterns
  • Collapsed technical reference: Moved ANSI color code tables and RGB specifications to a <details> section for optional reference
  • Added direct link: Linked to colors.go source file for developer reference

Example

Before (raw ANSI):

fmt.Println("\033[32m(✓) Done:\033[0m Creating resource")

After (helper functions):

fmt.Println(output.WithSuccessFormat("(✓) Done:") + " Creating resource")

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: kristenwomack <5034778+kristenwomack@users.noreply.github.com>
Copilot AI changed the title [WIP] Update contribution guidelines based on feedback Simplify color documentation to reference helper functions Jan 21, 2026
Copilot AI requested a review from kristenwomack January 21, 2026 00:12
@kristenwomack kristenwomack marked this pull request as ready for review January 21, 2026 03:54
@kristenwomack kristenwomack merged commit 620407c into update-contribution-guidelines Jan 21, 2026
1 check passed
@kristenwomack kristenwomack deleted the copilot/sub-pr-6420 branch January 21, 2026 03:54
kristenwomack added a commit that referenced this pull request Jan 21, 2026
* move extensions guideline into it's own file

* add initial azd-style-guide, add progress reports styles

* add guidance on color usage

* Add cspell overrides for new documentation files

* Revert cspell override changes

* Organize contribution docs and update links

* Organize documentation: split into style-guidelines and extensions

* Update cli/azd/docs/extensions/extensions-style-guide.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update cli/azd/docs/style-guidelines/azd-style-guide.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix merge conflict

* Update cli/azd/docs/style-guidelines/guiding-principles.md

Co-authored-by: puicchan <puichan@Microsoft.com>

* Simplify color documentation to reference helper functions (#6564)

* Initial plan

* Simplify color documentation to reference helper functions

Co-authored-by: kristenwomack <5034778+kristenwomack@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: kristenwomack <5034778+kristenwomack@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: puicchan <puichan@Microsoft.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants