-
Notifications
You must be signed in to change notification settings - Fork 28
Open
Description
Summary
The current README.md is missing some important sections that would make the repository look more professional and contributor-friendly.
Suggested Improvements
-
Add Badges
- License badge (MIT).
- GitHub repo stats (stars, forks, issues).
- Optional: Build/Deployment status if applicable.
-
Contributing Guidelines
- Create a CONTRIBUTING.md file or add a "Contributing" section in README.
- Include steps for forking, cloning, branching, and making PRs.
- Add code style / commit message conventions if needed.
-
Hall of Fame (Contributors Section)
- Recognize contributors with a Contributors/ Hall of Fame section.
- Use All Contributors or GitHub’s built-in contributors widget.
-
License Section
- Add a dedicated MIT License section (with link to LICENSE file).
- Include a badge for quick visibility.
-
Optional Enhancements
- Screenshots / demo (if project is visual).
- Table of contents for easy navigation.
- Contact / support section.
Why This Matters
- A well-structured README improves project visibility.
- Encourages new contributors to join.
- Builds a sense of community by recognizing contributors.
- Adds professionalism, making the repo stand out to recruiters/other devs.
As a GSSOC and OSCI contributor , I would like to work on this issue . Can you assign this to me?
Metadata
Metadata
Assignees
Labels
No labels