Restructure README.md for better readability and add CONTRIBUTING.md #252
+164
−460
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Created CONTRIBUTING.md with welcoming content for new contributors - Restructured README.md from 507 to 120 lines (76% reduction) - Converted verbose project descriptions to scannable table format - Added prominent Contributing section near the top - Organized projects into logical categories (Core Tools, Inspectors, Libraries, Other Tools) - Improved visual hierarchy with GitHub-style alerts - Maintained all essential information while improving readability - Verified documentation build succeeds This makes the README more beginner-friendly and less overwhelming for newcomers while preserving all project information in a more accessible format. Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
gyanranjanpanda
force-pushed
the
restructure-readme-251
branch
from
fbc2e89 to
b4c372b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #251
Summary
This PR addresses issue #251 by restructuring the README.md to make it more concise and beginner-friendly, reducing it from 507 lines to 120 lines (76% reduction).
Changes Made
Created CONTRIBUTING.md
docs/source/contributing.rstRestructured README.md
Before & After
Before: 507 lines with verbose "What/Why/Maintainer" subsections for each project
After: 120 lines with clean, scannable tables
Verification
make docs)Impact
This makes the README much more approachable for newcomers while maintaining all the information that existing contributors rely on. The table format is also easier to maintain going forward.