Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

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.

Sign up for GitHub

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

Open
swastim01 wants to merge 10 commits into
base: main
Choose a base branch
from
Open

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

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a99729e
Moved 'Making Good PRs' section up in the hierarchy and clarified its…
swastim01 Feb 9, 2025
38a16d6
Reversed the doc hierarchy as it was before
swastim01 Feb 9, 2025
0cdb96a
Improved capitalization, added #. instead of hardcoding, trimmed trai…
swastim01 Feb 9, 2025
5932e90
Update getting-started/pull-request-lifecycle.rst
swastim01 Feb 12, 2025
1c12ebd
Update getting-started/pull-request-lifecycle.rst
swastim01 Feb 12, 2025
980bac0
Update getting-started/pull-request-lifecycle.rst
swastim01 Feb 12, 2025
bd58b77
Update getting-started/pull-request-lifecycle.rst
swastim01 Feb 12, 2025
e43ccdf
Update getting-started/pull-request-lifecycle.rst
swastim01 Feb 12, 2025
d36d02e
Update getting-started/pull-request-lifecycle.rst
swastim01 Feb 12, 2025
057d5b4
Update getting-started/pull-request-lifecycle.rst
swastim01 Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update getting-started/pull-request-lifecycle.rst 
Co-authored-by: Stan Ulbrych <[email protected]>
  • Loading branch information
@swastim01 @StanFromIreland
swastim01 and StanFromIreland authored Feb 12, 2025
commit 057d5b4e9e5216c8860a55c34de7e97751d0ee76
6 changes: 0 additions & 6 deletions getting-started/pull-request-lifecycle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,12 +200,6 @@ When creating a pull request, following best practices ensures your contribution
- Use the **imperative mood** (e.g., "Fix crash in parser" instead of "Fixed a crash in parser").
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a link to a better guide/more information? This would be helpful for non English natives. https://en.wikipedia.org/wiki/Imperative_mood

- Be specific about what is being changed (avoid vague words like "Update" or "Fix").

**Avoid:**

- "Bug fix" → Too vague. What bug was fixed?
- "Update README" → What was updated? Be precise.
- "Refactoring" → Explain what was refactored and why.

**Example of a good PR title:**

``gh-128002: Simplify all_tasks to use PyList_Extend instead of manual iteration``
Expand Down