Skip to content

chore: cleanup repository formatting and documentation#197

Merged
j-d-ha merged 3 commits into
mainfrom
chore/cleanup-repo
Nov 28, 2025
Merged

chore: cleanup repository formatting and documentation#197
j-d-ha merged 3 commits into
mainfrom
chore/cleanup-repo

Conversation

@j-d-ha

@j-d-ha j-d-ha commented Nov 28, 2025

Copy link
Copy Markdown
Collaborator

🚀 Pull Request

📋 Summary

Minor cleanup improvements to repository formatting, documentation, and configuration consistency.

Key Changes:

  • Fixed formatting issues in envelope README documentation
  • Unified profile names across launchSettings.json files in example projects
  • Improved XML documentation formatting in CloudWatch Logs envelopes
  • Fixed formatting in OpenTelemetry middleware extensions

✅ Checklist

  • My changes build cleanly
  • I've added/updated relevant tests
  • I've added/updated documentation or README
  • I've followed the coding style for this project
  • I've tested the changes locally (if applicable)

🧪 Related Issues or PRs

N/A - General cleanup


💬 Notes for Reviewers

This PR contains only formatting and documentation improvements. No functional changes were made to the codebase.

Changes include:

  • Consistent profile naming in launch settings
  • Fixed markdown formatting in README files
  • Improved XML documentation formatting for better readability

- Removed extraneous control characters causing display issues in the list.
- Ensured consistent formatting for bullet points and descriptions.
- Replaced specific profile names with "Local" for consistency.
- Updated launchSettings.json in all example projects.
- Resolved line break inconsistencies in XML documentation comments across multiple classes.
- Removed an unnecessary blank line in the SNS envelope README.
- Standardized summary formatting in nested AWS logs envelope properties.
@github-actions github-actions Bot added the type: chore Maintenance task label Nov 28, 2025
@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Nov 28, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #197   +/-   ##
=======================================
  Coverage   90.65%   90.65%           
=======================================
  Files         102      102           
  Lines        2237     2237           
  Branches      252      252           
=======================================
  Hits         2028     2028           
  Misses        116      116           
  Partials       93       93           
Files with missing lines Coverage Δ
...Envelopes.CloudWatchLogs/CloudWatchLogsEnvelope.cs 100.00% <ø> (ø)
...lopes.CloudWatchLogs/CloudWatchLogsEnvelopeBase.cs 89.47% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1a803dc...b2c0da8. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@j-d-ha
j-d-ha merged commit 90d4fa1 into main Nov 28, 2025
8 checks passed
@j-d-ha
j-d-ha deleted the chore/cleanup-repo branch November 28, 2025 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: chore Maintenance task

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant