GitHub Pull Request 写作规范及示例

如何撰写规范的 GitHub Pull Request：示例指南

本文将提供一份示例 Pull Request，并以此为例说明如何撰写一份规范的 Pull Request。

该示例基于一个名为 'Awesome Project' 的开源项目的假设场景。

描述

本 Pull Request 包含以下更改：

• 添加了一个新的功能：在用户登录后显示欢迎消息。
• 修复了一个现有功能的错误：修复了登录表单验证错误的问题。

详细更改

1. 添加一个新的功能：在用户登录后显示欢迎消息。

• 在 src/components/LoginForm.js 中添加了一个新的函数：welcomeMessage()。
• 在 src/components/LoginForm.js 中更新了 handleSubmit() 函数，以便在用户成功登录后调用 welcomeMessage() 函数。
• 在 src/components/LoginForm.js 中添加了一条新的测试：测试 welcomeMessage() 函数是否正确地显示欢迎消息。

2. 修复一个现有功能的错误：修复了登录表单验证错误的问题。

• 在 src/components/LoginForm.js 中更新了 handleSubmit() 函数，以便在登录表单验证失败时正确地显示错误消息。
• 在 src/components/LoginForm.js 中添加了一条新的测试：测试 handleSubmit() 函数是否在登录表单验证失败时正确地显示错误消息。

更改目的

这些更改旨在提升用户体验并修复现有问题。当用户成功登录时，他们应该收到一条欢迎消息以改善他们的体验。此外，登录表单中的验证错误会导致用户感到沮丧和困惑，因此修复这个问题是必要的。

测试方法

您可以按照以下步骤测试这些更改：

1. 下载并安装项目代码。
2. 运行 npm install 安装所有依赖项。
3. 运行 npm start 启动应用程序。
4. 在应用程序中尝试登录，以确保欢迎消息正确显示。
5. 在登录表单中提供无效的凭据，以确保错误消息正确显示。

审核请求

请审核这些更改，并在合并到主分支之前提供反馈。谢谢！