devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Published 20 hours ago • verified publisher icon python

Improved 'Making Good PRs' section to improve clarity and maintainability.

Open swastim01 opened this issue 9 months ago • 4 comments

Improve PR Title Guidelines

Solves: https://github.com/python/devguide/issues/931

Description

  • Enforced a stricter PR title format to improve clarity and maintainability.
  • Encouraged writing accurate and concise PR titles/descriptions.

These changes aim to enhance the quality of PR titles.

📚 Documentation preview 📚: https://cpython-devguide--1510.org.readthedocs.build/getting-started/pull-request-lifecycle/

swastim01 avatar Feb 09 '25 10:02 swastim01

All commit authors signed the Contributor License Agreement.
CLA signed

ghost avatar Feb 09 '25 10:02 ghost

It's hard to review the changes because the section was moved in the page, please could you move it back?

I think it makes sense to keep the original order, where the "quick guide" comes first. (But if we do want to move it up a section, let's do that in a separate PR, with no other textual changes.)

hugovk avatar Feb 09 '25 12:02 hugovk

Hi, I have done the needful. Please let me know if any other changes are required.

swastim01 avatar Feb 09 '25 13:02 swastim01

The following commit authors need to sign the Contributor License Agreement:

CLA signed

python-cla-bot[bot] avatar Apr 18 '25 09:04 python-cla-bot[bot]