Skip to content

Fix documentation issue template link to use documentation.yml (#3149) - #3200

Open
reddy895 wants to merge 1 commit into
python:mainfrom
reddy895:issue-3149-docs-issue-link
Open

reddy895 wants to merge 1 commit into
python:mainfrom
reddy895:issue-3149-docs-issue-link

Conversation

@reddy895

Copy link
Copy Markdown

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 on python/cpython using:
https://github.com/python/cpython/issues/new?assignees=&labels=docs&template=documentation.md

In the python/cpython repository, the documentation issue template file is named documentation.yml (YAML form schema), not documentation.md. Because documentation.md does not exist (HTTP 404), clicking the link caused GitHub to load a blank issue form rather than the structured documentation issue form.

Implementation & Rationale

  • Updated the template parameter from documentation.md to documentation.yml in:
    • .github/ISSUE_TEMPLATE/BUG.yml
    • .github/ISSUE_TEMPLATE/DOCS.yml
    • .github/ISSUE_TEMPLATE/REQUEST.yml
  • Added an automated regression test in pydotorg/tests/test_issue_templates.py that validates all issue template YAML files for syntactic validity and asserts that all CPython documentation issue links reference documentation.yml and not documentation.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).
  • Regression test IssueTemplateTestCase.test_cpython_documentation_template_links_use_yml:
    AssertionError: 'template=documentation.md' unexpectedly found in ... : BUG.yml contains invalid template=documentation.md link (should be .yml)
    FAILED (failures=1)
    

After-Fix:

  • gh api repos/python/cpython/contents/.github/ISSUE_TEMPLATE/documentation.yml: HTTP 200 (Found, 473 bytes).
  • Regression test IssueTemplateTestCase.test_cpython_documentation_template_links_use_yml:
    Found 2 test(s).
    System check identified no issues (0 silenced).
    ..
    Ran 2 tests in 0.008s
    OK
    

Exact Test Commands and Outcomes

  • Lint:
    uv run ruff check . -> All checks passed!
  • Formatting:
    uv run ruff format --check . -> 658 files already formatted
    uv run pyproject-fmt --check pyproject.toml -> no change for pyproject.toml
  • Regression test suite:
    DATABASE_URL="sqlite:////tmp/test.db" uv run python ./manage.py test pydotorg.tests.test_issue_templates -> Ran 2 tests in 0.008s, OK
  • Adjacent unit tests:
    DATABASE_URL="sqlite:////tmp/test.db" uv run python ./manage.py test pydotorg.tests -> Ran 29 tests in 1.698s, OK

Remaining 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.

…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
@reddy895
reddy895 requested a review from JacobCoffee as a code owner October 26, 2026 04:35

This branch has not been deployed

No deployments
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.

Bug: Incorrect link to new documentation issue

1 participant