Skip to content

Improve first-time contributor onboarding in README with enforceable guidance#1318

Merged
SkBlaz merged 3 commits intomasterfrom
copilot/review-repo-for-contributors
Mar 29, 2026
Merged

Improve first-time contributor onboarding in README with enforceable guidance#1318
SkBlaz merged 3 commits intomasterfrom
copilot/review-repo-for-contributors

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 28, 2026

This issue asked for a contributor-perspective review and concrete changes that make first contributions faster and safer, without adding new markdown files.
This PR tightens the onboarding path in existing docs and adds a focused guardrail test so the guidance stays intact.

  • README: explicit first-PR quick path

    • Added a dedicated Contributing (First PR Quick Path) section to README.md.
    • Included a minimal, actionable command sequence for local setup + pre-PR checks.
    • Added high-signal helper commands for discoverability (make help, make ci).
  • README: contributor safety constraints

    • Added explicit no-new-markdown guidance and linked enforcement to tests/test_link_checker.py.
    • Clarified intent (prevent documentation drift) to reduce policy ambiguity for new contributors.
  • Test guardrail for onboarding regressions

    • Added tests/test_readme_contributor_onboarding.py.
    • Verifies:
      • onboarding section exists,
      • required contributor commands are present in the intended section,
      • explicit safety-policy wording remains present.
### Contributing (First PR Quick Path)

make setup
make dev-install
make format
make lint
make test

💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

Copilot AI linked an issue Mar 28, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Suggest changes to improve first contributions experience Improve first-time contributor onboarding in README with enforceable guidance Mar 28, 2026
Copilot AI requested a review from SkBlaz March 28, 2026 08:02
@SkBlaz SkBlaz marked this pull request as ready for review March 29, 2026 01:08
@SkBlaz SkBlaz merged commit af543df into master Mar 29, 2026
33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

contr

2 participants