Skip to content

Convert change/bug/known-issue sections to bullet lists#56

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/convert-tables-to-bullet-lists
Feb 8, 2026
Merged

Convert change/bug/known-issue sections to bullet lists#56
Malcolmnixon merged 3 commits intomainfrom
copilot/convert-tables-to-bullet-lists

Conversation

Copy link
Contributor

Copilot AI commented Feb 8, 2026

Pull Request

Description

Tables for changes, bugs, and known issues consume excessive space due to padding and cause poor page-breaks when rendered to PDF. Converted these sections to bullet lists while preserving the version information table.

Before:

## Changes
| Issue | Title |
| :-: | :---------- |
| [1](url) | Add feature X |

After:

## Changes
- [1](url) - Add feature X

Changes Made

  • BuildInformation.cs: Modified AppendChangesSection(), AppendBugsFixedSection(), and AppendKnownIssuesSection() to output bullet lists instead of tables
  • BuildInformationTests.cs: Updated 4 test cases to validate bullet list format; renamed BuildInformation_ToMarkdown_UsesCorrectTableWidths to BuildInformation_ToMarkdown_UsesBulletLists
  • requirements.yaml: Updated test reference for requirement RPT-009

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Related Issues

References feature request for more compact report output with better PDF rendering.

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All tests pass: dotnet test --configuration Release
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint '**/*.{yml,yaml}'

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Version Information section intentionally remains as a table - the structured tabular format is appropriate for key-value metadata. Only the list-oriented sections (Changes, Bugs Fixed, Known Issues) benefit from bullet list format.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Convert report change/bug/known-issue tables to bullet-lists</issue_title>
<issue_description>### Problem Statement

While the version-information table is perfectly fine, the change/bug/known-issue tables take up significant room for the table padding, and also don't page-break very well when converted to PDFs.

Proposed Solution

Convert the change/bug/known-issue tables to markdown bullet lists.

Alternatives Considered

No response

Usage Examples

Benefits

Less space and better page transitions in PDF.

Priority

Medium - Would improve my workflow

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful</issue_description>

Comments on the Issue (you are @copilot in this section)


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

Copilot AI and others added 2 commits February 8, 2026 13:22
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Convert change, bug, known-issue tables to bullet lists Convert change/bug/known-issue sections to bullet lists Feb 8, 2026
Copilot AI requested a review from Malcolmnixon February 8, 2026 13:27
@Malcolmnixon Malcolmnixon marked this pull request as ready for review February 8, 2026 13:41
@Malcolmnixon Malcolmnixon merged commit b4c6c4c into main Feb 8, 2026
11 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/convert-tables-to-bullet-lists branch February 8, 2026 13:41
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.

[Feature]: Convert report change/bug/known-issue tables to bullet-lists

2 participants