Skip to content

Revise CONTRIBUTING.md for clarity and structure#136

Open
ananyajoshi-cseai wants to merge 1 commit into
AditixAnand:mainfrom
ananyajoshi-cseai:main
Open

Revise CONTRIBUTING.md for clarity and structure#136
ananyajoshi-cseai wants to merge 1 commit into
AditixAnand:mainfrom
ananyajoshi-cseai:main

Conversation

@ananyajoshi-cseai

Copy link
Copy Markdown

Related Issue

Closes #135

Description

This PR overhauls the formatting and structure of the CONTRIBUTING.md file to make it much more readable, professional, and engaging for new contributors.

Key Changes:

  • Added bash syntax highlighting to terminal commands (e.g., git clone and git checkout).
  • Improved the visual hierarchy using markdown blockquotes and bold text to emphasize crucial warnings (specifically in the "Issue Selection" and "What Not to Do" sections).
  • Fixed broken code blocks and list indentation.
  • Ensured consistent spacing and integrated emojis for a welcoming aesthetic.

Type of PR

  • Bug fix
  • Feature enhancement
  • Documentation update
  • Security enhancement
  • Other

Checklist

  • I have performed a self-review of my code/markdown.
  • I have read and followed the Contribution Guidelines.
  • I have ensured that my changes do not break any existing functionality or links.

Additional Context

I am submitting this documentation improvement as part of my GSSoC '26 contributions! 🚀

Updated the CONTRIBUTING.md file to enhance clarity and formatting, including new sections for guidelines and rules.
Copilot AI review requested due to automatic review settings June 3, 2026 05:29

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the contributing guide to be more structured and readable, with clearer sections and examples for contributors.

Changes:

  • Reformatted the document with clearer headings, lists, and separators.
  • Added stricter/clearer contribution rules and a more explicit review process.
  • Improved commit message guidance with good/bad examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Enhance formatting and structure of CONTRIBUTING.md

2 participants