Skip to content

Restructure README.md#126

Merged
zkoppert merged 1 commit into
github-community-projects:mainfrom
rajveer43:patch-1
Sep 27, 2023
Merged

Restructure README.md#126
zkoppert merged 1 commit into
github-community-projects:mainfrom
rajveer43:patch-1

Conversation

@rajveer43
Copy link
Copy Markdown
Contributor

@rajveer43 rajveer43 commented Sep 21, 2023

Fixes #105

Proposed Changes

  • Addition of Table of Contents
  • Using Precise Language

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing
  • Label as either bug, documentation, enhancement, infrastructure, or breaking

@rajveer43 rajveer43 requested a review from zkoppert as a code owner September 21, 2023 08:23
@zkoppert zkoppert added the documentation Improvements or additions to documentation label Sep 21, 2023
@zkoppert
Copy link
Copy Markdown
Collaborator

Thanks for adding a table of contents with great descriptions! I appreciate you taking the time to contribute. Would you like to keep this PR open and work with @MihirKohli to make any other readability changes to the README or merge this through and open a new PR for any other changes?

Copy link
Copy Markdown
Collaborator

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

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

Looks like @MihirKohli opened a separate pull request so I will merge this one through. Thanks for adding this! 🚀

@zkoppert zkoppert merged commit b1d72a5 into github-community-projects:main Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README is really long

2 participants