Skip to content

Improve CONTRIBUTING.md for Clarity & Structure #135

@AditiTangri

Description

@AditiTangri

🧩 Description:

The current CONTRIBUTING.md provides essential steps, but its formatting and structure can be improved to enhance contributor experience. A polished and organized file encourages more meaningful and professional open-source contributions.

✅ Suggested Improvements:

✍️ Polish Section Titles with consistent emojis or hierarchy (e.g., ##, ###)

💡 Explain why contributors should follow certain steps (e.g., why upstream sync is important)

🎨 Improve code block formatting (fix extra backtick in clone block)

✅ Add a checklist for PRs

🎯 Goal:

Make the guide:

  • Easy to scan ✅

  • Professional-looking ✨

  • Friendly to beginners 👋

  • Compliant with best open-source practices 📘

Please assign this issue to me. I would like to contribute to this issue.

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