Skip to content

[GSSoC] Redesign & Enhancement of CONTRIBUTING.md for CineVerse #91

@AditiTangri

Description

@AditiTangri

Description:

The current CONTRIBUTING.md has been updated to provide a cleaner structure, professional tone, and better guidance for new and experienced contributors. This issue tracks the proposed redesign and formatting improvements.

Enhancements

  • Bold Key Actions
    Highlight important steps like Fork, Clone, Commit, PR for quick scanning.

  • Fix Typos or Redundancies
    Ensure consistent grammar, punctuation, and phrasing.

  • Use Consistent Heading Levels
    Stick to ## for main sections and ### for sub-sections.

  • Add Inline Code Formatting
    Use backticks for commands (git clone, npm install) for better readability.

  • Highlight Important Notes
    Use blockquotes (>) to emphasize tips or warnings.

  • Add Short “Thank You” Note at the End
    Appreciate contributors with a friendly closing line.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions