Improve new contributor onboarding in README and CONTRIBUTING#899
Closed
pranjal2004838 wants to merge 4 commits intozulip:mainfrom
Closed
Improve new contributor onboarding in README and CONTRIBUTING#899pranjal2004838 wants to merge 4 commits intozulip:mainfrom
pranjal2004838 wants to merge 4 commits intozulip:mainfrom
Conversation
Author
|
Hi! Just checking in to see if there’s anything else needed from my side. |
Author
|
@Niloth-p could you review this when you get a chance? All tests passing and ready to go 🙏 |
Contributor
|
Before attempting to rewrite the entire README, I would recommend reading it first. Especially the Contributing Guide that it points to. |
Contributor
|
Please carefully review our AI use policy prior to submitting any future PRs to this project. Submitting AI-generated spam PRs to open-source projects wastes maintainers' time, and will result in being banned from this project. |
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.
Summary
This PR improves the onboarding experience for first-time contributors by
making the project purpose clearer and adding a short, actionable path to
getting started.
The goal is to reduce initial cognitive load before contributors dive into the
full documentation.
Motivation
While reading the README and CONTRIBUTING guide as a new contributor, I found
that:
“what should I do first?” for contributors.
high-level entry point.
This PR adds lightweight structure to address those gaps without changing any
existing contribution policies.
What’s changed
README
CONTRIBUTING
Scope and intent
Testing
N/A (documentation-only changes)