Skip to content

GH-931: Improve "Making Good PRs" docs with title guidelines and structure #1521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

Austin-John
Copy link

@Austin-John Austin-John commented Feb 24, 2025

Improve the "Making Good PRs" section

  • Adds explicit rules for PR titles (imperative verbs, GH-issue references).
  • Includes a PR submission checklist and examples of good/bad titles.

Fixes GH-931


📚 Documentation preview 📚: https://cpython-devguide--1521.org.readthedocs.build/

@ghost
Copy link

ghost commented Feb 24, 2025

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

Click the button to sign:
CLA not signed

@hugovk
Copy link
Member

hugovk commented Feb 24, 2025

Did you check the output of this?

Did you use ChatGPT for this? Please see our policy on generative AI: https://devguide.python.org/getting-started/generative-ai/

And remember to sign the CLA.

@hugovk
Copy link
Member

hugovk commented Feb 24, 2025

Actually, these changes have been made to wrong file. The contrib/ files are a work in progress, see the (important) text you deleted.

@hugovk hugovk closed this Feb 24, 2025
@Austin-John
Copy link
Author

Hi @hugovk,
Thank you for reviewing my PR and for the opportunity to contribute! I understand that someone else had already addressed the issue, and I’m glad it’s resolved now.

This was my first time contributing to an open-source project, and I learned a lot in the process. I’m excited to continue contributing. If you have any advice on how I can get more involved in open source or improve my contributions, I’d really appreciate it!

Best regards

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.

Improve the "Making Good PRs" section
2 participants