GitHubにコミットする際のsummaryやdescriptionの書き方

概要

summary

一言で説明すると、何を変更したかを簡潔にまとめたもの。例えば、「Fix a bug」、「Add a new feature」など。

description

変更の詳細な説明。 変更の目的や背景、変更内容の詳細、影響範囲などを記述する。また、レビュワーに対して、特にチェックしてもらいたい箇所や注意点なども明記すると良い。

特に、複数のコミットを一度にまとめる場合は、各コミットの変更点を簡潔にまとめたsummaryと、それらを総合した全体の説明を含むdescriptionを用意することが重要。これにより、後からプロジェクトを参加する人や、プロジェクトの変更履歴を確認する人が、変更内容を把握しやすくなる。

summaryの例

• Fix a bug that caused the application to crash when uploading large files
• Add a new feature to allow users to sort their tasks by priority
• Update the design of the login page to improve usability
• Refactor the code for better performance and maintainability
• Improve error handling for better user experience

descriptionの例

• Fix a bug that caused the application to crash when uploading large files:

  • The previous implementation of the file upload functionality did not handle large files properly, leading to a crash when trying to upload files larger than a certain size. This has been fixed by optimizing the file upload process and adding proper error handling.

• Add a new feature to allow users to sort their tasks by priority:

  • Users can now sort their tasks by priority, which makes it easier to focus on the most important tasks. The sorting functionality can be accessed via a new dropdown menu in the task list.

• Update the design of the login page to improve usability:

  • The login page has been updated to have a more modern and user-friendly design. The new design includes clearer labels and buttons, as well as a simplified layout.

• Refactor the code for better performance and maintainability:

  • The code has been refactored to improve performance and maintainability. This includes removing duplicate code, optimizing database queries, and improving code readability.

• Improve error handling for better user experience:

  • Error handling has been improved throughout the application to provide a better user experience. This includes adding more descriptive error messages and handling errors more gracefully.