Revise README.md for improved language and flow#2575
Open
OptimumCoder1 wants to merge 1 commit intoDeepSourceCorp:masterfrom
Open
Revise README.md for improved language and flow#2575OptimumCoder1 wants to merge 1 commit intoDeepSourceCorp:masterfrom
OptimumCoder1 wants to merge 1 commit intoDeepSourceCorp:masterfrom
Conversation
Updated wording for clarity and readability. Signed-off-by: Sriman Samudrala <[email protected]>
|
@OptimumCoder1 is attempting to deploy a commit to the DeepSource Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
This PR refines the introductory wording in the README to improve clarity and readability around the “Good First Issue” initiative and project submission instructions.
Changes:
- Clarified the description of the “Good First Issue” initiative and its purpose.
- Rephrased the explanation of how easy issues help lower the barrier for new contributors.
- Tweaked the wording of the “Adding a new project” section for smoother flow.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Adding a new project | ||
|
|
||
| You're welcome to add a new project to Good First Issue, and we encourage all projects — old and new, big and small. | ||
| You're welcome to add a new project to Good First Issue, and we encourage all projects &mdash old and new, big and small. |
There was a problem hiding this comment.
The HTML entity &mdash is missing its terminating semicolon, so it will likely render incorrectly as literal text instead of an em dash; it should use the full — entity to preserve the intended punctuation in the rendered README.
Suggested change
| You're welcome to add a new project to Good First Issue, and we encourage all projects &mdash old and new, big and small. | |
| You're welcome to add a new project to Good First Issue, and we encourage all projects — old and new, big and small. |
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
1 participant
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.
Updated wording for clarity and readability.
ℹ️ Repository information
The repository has:
good first issuelabel.