Fix broken contact reference in contributing.rst by adding proper contact link#14010
Fix broken contact reference in contributing.rst by adding proper contact link#14010bluetech merged 4 commits intopytest-dev:mainfrom
Conversation
|
The links are not broken, as can be seen here: https://docs.pytest.org/en/stable/contributing.html#fix-bugs. Can you explain where you saw this? |
The link are broken here: https://github.com/pytest-dev/pytest?tab=contributing-ov-file#fix-bugs and here: https://github.com/pytest-dev/pytest?tab=contributing-ov-file#implement-features |
|
The links are meant for the Sphinx-build docs but I guess CONTRIBUTING.rst specifically is more likely to be read through github which doesn't resolve such references. So I figure we can make an exception for it and merge this. Thanks. |
What
Fixed two instances of broken
:ref:Talk `` references in CONTRIBUTING.rstChanges Made
:ref:Talkto developerswith proper RST linkTalk to developers <https://docs.pytest.org/en/stable/contact.html>_ in the "Fix bugs" section:ref:Talkto developerswith proper RST linkTalk to developers <https://docs.pytest.org/en/stable/contact.html>_ in the "Implement features" sectionWhy
The original reStructuredText
:ref:syntax was malformed and not rendering as clickable links, which could confuse new contributors trying to contact the development team. The new links directly point to the pytest contact documentation page.Result
Now contributors can easily click through to the contact channels page instead of seeing broken references.