Skip to content

Conversation

@paras-chinchalkar
Copy link

Title: docs: Add onboarding guide and README link

Body:
Short summary:
Adds a concise onboarding guide for new Augur contributors and links it from the repository README to help newcomers find community, setup, and first-contribution resources more quickly.

What changed:

Added docs/onboarding.md — a short, actionable onboarding guide covering:
joining the CHAOSS community (Slack, meetings, YouTube)
running Augur locally (docs + Docker pointers)
finding starter issues (first-timers-only, good first issue)
where to ask for help and how to escalate
pointers for more challenging work
Updated README.md — inserted an "Onboarding for New Contributors" section linking to docs/onboarding.md.
Why:
This provides a clear, discoverable path for newcomers (derived from community suggestions) to get started contributing to Augur and reduces friction for first-time contributors. Relates to community discussion in issues #3442 and #3446.

Related issues / credit:

References: #3442, #3446
Contributor: @MoralCode (original suggestion)
Files: docs/onboarding.md, README.md

@@ -0,0 +1,31 @@
## Onboarding Guide for New Augur Contributors
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@paras-chinchalkar : I am unfamiliar with the onboarding.md file's origin story. I know there are an ever growing number of "standard" files being dropped into repositories, but I could use a little history and context to evaluate whether this file fits how we operate. Also interested in what @MoralCode thinks.

THANK YOU for the contribution. This comment is simply to make you aware that we need a minute. :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have already given this feedback to another contributor who is solving this same issue, but IMO this list of guideposts (from the issue) should be in CONTRIBUTING.md. Im not aware of ONBOARDING.md being a widely used practice

@sgoggins sgoggins added the discussion Seeking active feedback, usually for items under active development label Dec 9, 2025
@MoralCode MoralCode added the redundant PR is submitted in parallel with another mutually exclusive PR label Dec 11, 2025
@MoralCode MoralCode linked an issue Dec 11, 2025 that may be closed by this pull request
@MoralCode MoralCode added the documentation Updates documentation label Dec 15, 2025
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this content to CONTRIBUTING.md. Your changes in #3448 (comment) may also be a helpful summary too if you decide to bring those over.

@MoralCode MoralCode added the pending changes PRs that have review comments that have been added but havent been addressed in a while label Dec 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

discussion Seeking active feedback, usually for items under active development documentation Updates documentation pending changes PRs that have review comments that have been added but havent been addressed in a while redundant PR is submitted in parallel with another mutually exclusive PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document onboarding process

3 participants