docs: improve contributor setup and PR template#17
Merged
ulises-jeremias merged 1 commit intoJul 17, 2026
Merged
Conversation
sahilmathur254
marked this pull request as ready for review
July 16, 2026 08:24
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CONTRIBUTING.mdwith prerequisites, fork and local setup steps, validation commands, and pull request guidance.Closes #16.
Type of change
How Has This Been Tested?
uv run scripts/validate_all_modules.pyuv run scripts/validate_ci_gate.pyuv run scripts/run_topic_tests.py TARGETValidation ran in an isolated Python 3.12 Docker environment:
python -m mdformat --check CONTRIBUTING.md .github/pull_request_template.mdpython scripts/validate_ci_gate.pypassed; 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_stringspassed all 5 tests.git diff --checkpassed.Checklist