Skip to content

Improve contributor onboarding visibility in README#60443

Merged
ViralBShah merged 3 commits intoJuliaLang:masterfrom
arkgupta17:docs-readme-contributing
Dec 22, 2025
Merged

Improve contributor onboarding visibility in README#60443
ViralBShah merged 3 commits intoJuliaLang:masterfrom
arkgupta17:docs-readme-contributing

Conversation

@arkgupta17
Copy link
Copy Markdown
Contributor

The README already references CONTRIBUTING.md, but the entry point for new contributors
is easy to miss. This PR adds a small, dedicated “Contributing” section to improve
discoverability, without duplicating existing documentation or changing contribution rules.

@ViralBShah
Copy link
Copy Markdown
Member

This looks good - but it feels a bit redundant given the CONTRIBUTING.md file. It also repeats some of the community links and I am not sure if the Julia key committers are all on zulip.

My preference would be to significantly reduce the size of this section, while still trying to be a bit more prominent.

Copy link
Copy Markdown
Member

@LilithHafner LilithHafner left a comment

Choose a reason for hiding this comment

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

This LGTM. I'll wait a bit before merging to see if other folks have feedback.

Comment thread README.md Outdated

- [**Learning resources**](https://julialang.org/learning/)


Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This seems unrelated/accidental. We try not to include unrelated whitespace changes in PRs.

Comment thread README.md Outdated
Comment on lines +65 to +72
To find suitable issues:
- Browse GitHub issues: https://github.com/JuliaLang/julia/issues
- Look for labels such as `good first issue`, `docs`, or `help wanted`

For questions and discussion:
- Discourse: https://discourse.julialang.org
- Zulip: https://julialang.zulipchat.com

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@ViralBShah's points are good. Maybe delete this part?

Suggested change
To find suitable issues:
- Browse GitHub issues: https://github.com/JuliaLang/julia/issues
- Look for labels such as `good first issue`, `docs`, or `help wanted`
For questions and discussion:
- Discourse: https://discourse.julialang.org
- Zulip: https://julialang.zulipchat.com

@LilithHafner LilithHafner added the docs This change adds or pertains to documentation label Dec 21, 2025
@arkgupta17
Copy link
Copy Markdown
Contributor Author

Thanks for the feedback! I’ve reduced the Contributing section to a concise pointer
to CONTRIBUTING.md, removed duplicated content, and fixed the formatting.
Please let me know if this looks good now.

Comment thread README.md Outdated
Co-authored-by: Lilith Orion Hafner <lilithhafner@gmail.com>
@ViralBShah ViralBShah merged commit 49bc325 into JuliaLang:master Dec 22, 2025
4 of 8 checks passed
@arkgupta17 arkgupta17 deleted the docs-readme-contributing branch December 24, 2025 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs This change adds or pertains to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants