Improving README quality for CPP project - #1
Merged
Merged
Conversation
Co-authored-by: yash-kumar-18 <319969211+yash-kumar-18@users.noreply.github.com>
Co-authored-by: yash-kumar-18 <319969211+yash-kumar-18@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
yash-kumar-18
September 6, 2026 17:54
View session
yash-kumar-18
marked this pull request as ready for review
September 6, 2026 17:55
There was a problem hiding this comment.
🟡 Changes recommended
The “How to Run” section currently documents only a POSIX-style run command, which can mislead Windows users given the stated “terminal / command prompt” requirement.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR streamlines the repository README into a shorter, more scannable structure (overview → project list → requirements/run steps → license/goal) suitable for a beginner C++ exercises collection.
Changes:
- Replaced per-project long-form “Purpose/Process” descriptions with a concise Projects index.
- Added clear “Requirements” and “How to Run” steps for compiling/running individual
.cppprograms. - Kept an explicit MIT License section linking to
LICENSE.
File summaries
| File | Description |
|---|---|
| README.md | Rewrites and condenses documentation into structured sections with a project index and run instructions. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+54
to
+57
| 3. Run the program: | ||
| ```bash | ||
| ./Simple_Calculator | ||
| ``` |
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.
Pull request created by AI Agent