Skip to content

Improve CONTRIBUTING.md UI & Formatting #881

Closed

Description

@AditiTangri

Description:

The current CONTRIBUTING.md file contains helpful content, but it can be enhanced with better formatting and visual styling to improve readability and user engagement.

Suggested Enhancements:

  • Use emojis and consistent headings for better visual hierarchy

  • Apply code block formatting to shell commands and config variables

  • Convert plain links to hyperlinked text (e.g., Open Issue)

  • Use checklists and tables for instructions and contribution rules

  • Add info/warning callouts using > blockquotes for tips or important notes

  • Standardize section titles (e.g., all Title Case or all sentence case)

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

Activity

  1. github-actions commented on Oct 22, 2025

    @github-actions

    Thank you for raising this issue!

    We'll review it as soon as possible. We truly appreciate your contributions! ✨

    Meanwhile make sure you've visited the README.md, CONTRIBUTING.md, and CODE_OF_CONDUCT.md before creating a PR for this. Also, please do NOT create a PR until this issue has been assigned to you. 😊

  2. added
    documentationImprovements or additions to documentation
    gssoc25Girlscript Summer of Code 2025
    on Oct 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Level1documentationImprovements or additions to documentationgssoc25Girlscript Summer of Code 2025

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions