Repository navigation
Conversation
…n#3149) GitHub issue templates BUG.yml, DOCS.yml, and REQUEST.yml linked to python/cpython documentation issue creation using 'template=documentation.md'. However, CPython's issue template is 'documentation.yml', which caused GitHub to render a blank form instead of the structured documentation issue template. - Update template parameter from documentation.md to documentation.yml - Add regression test in pydotorg/tests/test_issue_templates.py
This branch has not been deployed
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.
Issue Addressed
Closes #3149: Incorrect link to new documentation issue
Verified Root Cause
The GitHub issue templates (
.github/ISSUE_TEMPLATE/BUG.yml,.github/ISSUE_TEMPLATE/DOCS.yml, and.github/ISSUE_TEMPLATE/REQUEST.yml) included an introductory note directing users with Python documentation bugs to file them onpython/cpythonusing:https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.mdIn the
python/cpythonrepository, the documentation issue template file is nameddocumentation.yml(YAML form schema), notdocumentation.md. Becausedocumentation.mddoes not exist (HTTP 404), clicking the link caused GitHub to load a blank issue form rather than the structured documentation issue form.Implementation & Rationale
templateparameter fromdocumentation.mdtodocumentation.ymlin:.github/ISSUE_TEMPLATE/BUG.yml.github/ISSUE_TEMPLATE/DOCS.yml.github/ISSUE_TEMPLATE/REQUEST.ymlpydotorg/tests/test_issue_templates.pythat validates all issue template YAML files for syntactic validity and asserts that all CPython documentation issue links referencedocumentation.ymland notdocumentation.md.Before-Fix and After-Fix Evidence
Before-Fix:
gh api repos/python/cpython/contents/.github/ISSUE_TEMPLATE/documentation.md: returned HTTP 404 (Not Found).IssueTemplateTestCase.test_cpython_documentation_template_links_use_yml:After-Fix:
gh api repos/python/cpython/contents/.github/ISSUE_TEMPLATE/documentation.yml: HTTP 200 (Found, 473 bytes).IssueTemplateTestCase.test_cpython_documentation_template_links_use_yml:Exact Test Commands and Outcomes
uv run ruff check .->All checks passed!uv run ruff format --check .->658 files already formatteduv run pyproject-fmt --check pyproject.toml->no change for pyproject.tomlDATABASE_URL="sqlite:////tmp/test.db" uv run python ./manage.py test pydotorg.tests.test_issue_templates->Ran 2 tests in 0.008s, OKDATABASE_URL="sqlite:////tmp/test.db" uv run python ./manage.py test pydotorg.tests->Ran 29 tests in 1.698s, OKRemaining Limitations
None for this issue. The fix strictly addresses the issue template URL in this repository and adds automated regression testing.
Diff Scope
Narrowly scoped to the 3 issue template YAML files and the new regression test module
pydotorg/tests/test_issue_templates.py.