Skip to content

Commit

Permalink
Improve docs to show how good vs bad PR titles should be written
Browse files Browse the repository at this point in the history
  • Loading branch information
tanertopal committed May 15, 2023
1 parent f2cf4e4 commit edae12e
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions doc/source/first-time-contributors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,32 @@ Open PR
- Congrats! 🥳 You're now officially a Flower contributor!


Examples for good vs bad PR titles
----------------------------------

A well-crafted PR title helps team members quickly understand the purpose and scope of the changes being proposed. Here's a guide to help you write a good GitHub PR title:

1. Be Clear and Concise: Provide a clear summary of the changes in a concise manner.
1. Use Actionable Verbs: Start with verbs like "Add," "Update," or "Fix" to indicate the purpose.
1. Include Relevant Information: Mention the affected feature or module for context.
1. Keep it Short: Avoid lengthy titles for easy readability.
1. Use Proper Capitalization and Punctuation: Follow grammar rules for clarity.

Here are a few bad examples which do not provide any additional helpful information.

* Implement Algorithm
* Database
* Add my_new_file.py to codebase
* Improve code in module
* Change SomeModule

Here are a few good examples which provide helpful information without repeating how they do it, as that is already visible in the "Files changed" section of the PR.

* Update docs banner to mention Flower Summit 2023
* Remove unnecessary XGBoost dependency
* Remove redundant attributes in strategies subclassing FedAvg
* Add CI job to deploy the staging system when the `main` branch changes
* Add new amazing library which will be used to improve the simulation engine

Next steps
----------
Expand Down

0 comments on commit edae12e

Please sign in to comment.