Skip to content

docs: improve contributor setup and PR template#17

Merged
ulises-jeremias merged 1 commit into
nanlabs:mainfrom
sahilmathur254:fix/16-add-contributor-friendly-repository-
Jul 17, 2026
Merged

docs: improve contributor setup and PR template#17
ulises-jeremias merged 1 commit into
nanlabs:mainfrom
sahilmathur254:fix/16-add-contributor-friendly-repository-

Conversation

@sahilmathur254

Copy link
Copy Markdown
Contributor

Summary

  • Expand CONTRIBUTING.md with prerequisites, fork and local setup steps, validation commands, and pull request guidance.
  • Update the existing pull request template with the requested change-type, testing, and checklist sections.
  • Keep the canonical lowercase template path required by the repository charter.

Closes #16.

Type of change

  • Documentation
  • Bug fix
  • New or updated learning content
  • Repository tooling
  • Other

How Has This Been Tested?

  • uv run scripts/validate_all_modules.py
  • uv run scripts/validate_ci_gate.py
  • uv run scripts/run_topic_tests.py TARGET
  • Manual validation (details below)

Validation ran in an isolated Python 3.12 Docker environment:

  • python -m mdformat --check CONTRIBUTING.md .github/pull_request_template.md
  • python scripts/validate_ci_gate.py passed; 15 of 16 modules validated and the gate accepted the repository's existing transitional FastAPI exception.
  • python scripts/run_topic_tests.py 01_python_fundamentals/advanced_strings passed all 5 tests.
  • git diff --check passed.

Checklist

  • I followed the contribution guidelines.
  • I kept the change focused and used English throughout.
  • I added or updated tests and documentation where applicable.
  • I did not introduce TODO placeholders or unrelated changes.

@sahilmathur254
sahilmathur254 marked this pull request as ready for review July 16, 2026 08:24
@ulises-jeremias

Copy link
Copy Markdown
Member

Thanks @sahilmathur254! Looks good on a quick pass. CI has not reported checks yet on this branch — once workflows run green we can merge.

@ulises-jeremias
ulises-jeremias merged commit 6517840 into nanlabs:main Jul 17, 2026
2 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.

Add contributor-friendly repository templates and local setup notes

2 participants