Improve README and CONTRIBUTING to lower onboarding barrier for new contributorsdocs: improve onboarding with quick start and contributor guidance#11847
Open
pranjal2004838 wants to merge 1 commit intopubliclab:mainfrom
Conversation
Author
|
It looks like some CI checks are failing, but this PR only includes documentation Please let me know if you’d like me to rebase or make any adjustments on my side. |
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 newcomer onboarding by adding clear, low-barrier entry points
to both README.md and CONTRIBUTING.md, while preserving existing detailed
documentation for advanced users.
Changes Made
README.md
with three easy setup options:
CONTRIBUTING.md
Motivation
As a new contributor exploring this repository, I noticed that while the existing
documentation is thorough, it can feel overwhelming at first. These changes aim
to make the first 5–10 minutes smoother for newcomers (especially via Gitpod),
while keeping full documentation available for experienced contributors.
This aligns with Public Lab’s goal of being accessible and welcoming to new
contributors.
Notes
Happy to adjust wording or structure based on maintainer feedback.