Bỏ qua để đến nội dung

Viết PR và README tốt

Trong code review, mô tả PR là điểm vào cho người xem xét. Mô tả PR tốt giúp:

  • ✅ Người xem xét nhanh chóng hiểu bạn đã làm gì
  • ✅ Giảm các câu hỏi qua lại
  • ✅ Thể hiện bạn suy nghĩ kỹ lưỡng

Cấu trúc chuẩn của mô tả PR: What/Why/How/Testing

Phần tiêu đề “Cấu trúc chuẩn của mô tả PR: What/Why/How/Testing”

Tóm tắt ngắn gọn, một câu.

Refactor authentication flow to support OAuth2 and magic link sign-up

Biểu đạt chính:

  • Add X — thêm tính năng mới
  • Fix X — sửa bug
  • Refactor X — viết lại code (không thay đổi chức năng)
  • Optimize X — cải thiện hiệu suất

Phần thường bị bỏ qua nhất. Giải thích bối cảnh và động lực.

Why:
- Users requested passwordless sign-up option
- Current session-based auth doesn't scale to multiple domains

Tổng quan kỹ thuật cấp cao.

How:
1. Created JWT service using Web Crypto API
2. Replaced SessionMiddleware with AuthMiddleware
3. Added OAuth2 routes for Google/GitHub sign-in
Breaking changes:
- Clients now need to store and send JWT in Authorization header
Testing:
- Manual testing: Verified OAuth2 sign-in with Google and GitHub
- Existing auth tests pass (147 tests)
- Added 23 new tests
## What
[tóm tắt một câu]
## Why
- [lý do 1]
- [lý do 2]
## How
1. [thay đổi 1]
2. [thay đổi 2]
## Testing
- [bạn đã kiểm tra gì]
## Related
Closes #123

Nguyên tắc: hiện tại cho code làm gì, quá khứ cho thay đổi bạn đã thực hiện

SaiĐúng
”The function was created to handle X""The function handles X"
"The code will validate input""The code validates input”
Bị độngChủ động (tốt hơn)
“The JWT is generated by the server""The server generates the JWT"
"Breaking changes were introduced""This PR introduces breaking changes”
TừCách dùng
AddThêm tính năng mới: “Add OAuth2 support”
FixSửa bug: “Fix race condition in cache”
RefactorCải thiện code, không thay đổi chức năng
OptimizeCải thiện hiệu suất
  • Phần What giải thích rõ ràng thay đổi
  • Phần Why có lý do kỹ thuật hoặc kinh doanh
  • Phần How cho thấy thiết kế tổng quan
  • Phần Testing nêu phạm vi kiểm tra
  • Không có thể bị động quá mức
  • Liên kết đến issue liên quan (nếu có)