Skip to content

minor updates to README#228

Merged
ericbuckley merged 4 commits into
mainfrom
docs/add-missing-toc
Feb 27, 2025
Merged

minor updates to README#228
ericbuckley merged 4 commits into
mainfrom
docs/add-missing-toc

Conversation

@ericbuckley

@ericbuckley ericbuckley commented Feb 27, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Description

adding table of contents to main README along with a couple of badges.

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

@codecov

codecov Bot commented Feb 27, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.69%. Comparing base (d54af84) to head (b518d4f).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #228   +/-   ##
=======================================
  Coverage   97.69%   97.69%           
=======================================
  Files          32       32           
  Lines        1651     1651           
=======================================
  Hits         1613     1613           
  Misses         38       38

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ericbuckley ericbuckley changed the title adding TOC to main README minor updates to README Feb 27, 2025
@ericbuckley ericbuckley self-assigned this Feb 27, 2025
@ericbuckley ericbuckley added the documentation Improvements or additions to documentation label Feb 27, 2025
@ericbuckley ericbuckley marked this pull request as ready for review February 27, 2025 03:11
bamader
bamader approved these changes Feb 27, 2025
View reviewed changes

@bamader bamader left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@ericbuckley ericbuckley merged commit c54ff62 into main Feb 27, 2025
@ericbuckley ericbuckley deleted the docs/add-missing-toc branch February 27, 2025 15:36
bamader pushed a commit that referenced this pull request Mar 19, 2025
@ericbuckley @bamader
minor updates to README (#228)
975b9c8 
## Description
adding table of contents to main README along with a couple of badges.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bamader bamader bamader approved these changes

@m-goggins m-goggins Awaiting requested review from m-goggins m-goggins is a code owner

Assignees

@ericbuckley ericbuckley

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ericbuckley @bamader