Skip to content

Enhance and improve README.md with License Badge, Contributors Guide & Hall of Fame #58

@Ardhaya-Johari

Description

@Ardhaya-Johari

Summary

The current README.md is missing some important sections that would make the repository look more professional and contributor-friendly.

Suggested Improvements

  1. Add Badges

    • License badge (MIT).
    • GitHub repo stats (stars, forks, issues).
    • Optional: Build/Deployment status if applicable.
  2. 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.
  3. Hall of Fame (Contributors Section)

    • Recognize contributors with a Contributors/ Hall of Fame section.
    • Use All Contributors or GitHub’s built-in contributors widget.
  4. License Section

    • Add a dedicated MIT License section (with link to LICENSE file).
    • Include a badge for quick visibility.
  5. 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

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions