-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Labels
fto-candidateissues which are meant to be solved by first timers but aren't well-formatted yetissues which are meant to be solved by first timers but aren't well-formatted yet
Description
Summary
While exploring this repository as a new contributor, I found that the existing
README.md and CONTRIBUTING.md are helpful but could be improved to make onboarding
smoother for first-time contributors.
Observations
- Setup instructions could be more explicit and step-by-step for newcomers
- Some sections assume prior familiarity with the Public Lab ecosystem
- CONTRIBUTING.md could better explain the expected workflow (issues → discussion → PR)
- A short "Getting Started" or "First Contribution" section would help new contributors
Proposed Improvements
- Clarify local development setup steps
- Add a brief project overview and architecture explanation
- Improve structure and readability of README.md
- Add contributor-friendly guidance and links in CONTRIBUTING.md
Motivation
Clear documentation lowers the barrier for new contributors and helps build a
stronger contributor community, which aligns well with Public Lab’s mission.
I’d be happy to work on these improvements if this sounds useful.
Metadata
Metadata
Assignees
Labels
fto-candidateissues which are meant to be solved by first timers but aren't well-formatted yetissues which are meant to be solved by first timers but aren't well-formatted yet