Revise CONTRIBUTING.md for clarity and structure#136
Open
ananyajoshi-cseai wants to merge 1 commit into
Open
Conversation
Updated the CONTRIBUTING.md file to enhance clarity and formatting, including new sections for guidelines and rules.
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue
Closes #135
Description
This PR overhauls the formatting and structure of the
CONTRIBUTING.mdfile to make it much more readable, professional, and engaging for new contributors.Key Changes:
bashsyntax highlighting to terminal commands (e.g.,git cloneandgit checkout).Type of PR
Checklist
Additional Context
I am submitting this documentation improvement as part of my GSSoC '26 contributions! 🚀