Hướng dẫn dự án

Mẫu CONTRIBUTING.md cho kho mã nguồn mở

Tệp CONTRIBUTING.md giúp một người chuyển từ “Tôi muốn giúp” sang issue hoặc pull request hữu ích. Giải thích đóng góp nhỏ nhất được hỗ trợ và cách kiểm chứng. Yêu cầu phải phản ánh cách dự án thực sự hoạt động, không phải quy trình đầy tham vọng mà không ai tuân theo.

Ban biên tập GitHubStart · Cập nhật

Sao chép và điều chỉnh mẫu đóng góp

Thay chỗ giữ chỗ và kiểm chứng mọi lệnh, liên kết. Luôn chào đón sửa tài liệu và báo lỗi ngay cả khi người đóng góp chưa sẵn sàng sửa mã ứng dụng.

# Đóng góp

## Trước khi bắt đầu
Đọc README và kiểm tra các issue hiện có.
Với thay đổi lớn, hãy thảo luận cách tiếp cận trước khi triển khai.

## Thiết lập cục bộ
[Môi trường chạy cần thiết và các lệnh thiết lập đã kiểm chứng]

## Báo lỗi
Nêu phiên bản, môi trường, các bước, kết quả mong đợi và kết quả thực tế.
Xóa bí mật và dữ liệu cá nhân khỏi nhật ký.

## Gửi pull request
- Giải thích vấn đề và thay đổi đề xuất.
- Giữ thay đổi tập trung.
- Chạy [các kiểm tra riêng của dự án].
- Cập nhật tài liệu bị ảnh hưởng.

## Rà soát
[Ai rà soát, cách phản hồi và thời gian sẵn sàng thực tế]

## Cách giúp đỡ khác
[Tài liệu, ví dụ, bản dịch hoặc báo cáo có thể tái hiện]

Giúp hướng dẫn dễ tìm

GitHub nhận diện hướng dẫn đóng góp trong thư mục gốc kho mã, docs hoặc .github. Cũng dẫn liên kết từ README để người đọc phần giới thiệu tìm thấy quy trình ngay.

Rà soát đường đi từ các điểm bắt đầu đóng góp thực tế của kho mã. Nếu có nhiều tệp hướng dẫn, hãy hợp nhất chỉ dẫn mâu thuẫn. Người đóng góp không nên nhận một lệnh thiết lập trong README rồi một lệnh khác không được hỗ trợ trong hướng dẫn đóng góp.

Thiết kế một đóng góp đầu tiên dễ tiếp cận

Chọn nhiệm vụ nhỏ có kết quả rõ ràng, như sửa ví dụ cho môi trường chạy được hỗ trợ. Giải thích cách tái hiện lỗi, hành vi cần thay đổi và cách kiểm tra hoàn thành. Đừng gắn nhãn thân thiện với người mới nếu nhiệm vụ phụ thuộc kiến thức nội bộ chưa được viết ra.

Nói thật về thời gian có thể rà soát. Nếu không thể hứa thời hạn phản hồi, hãy cho biết cách người đóng góp kiểm tra trạng thái. Ranh giới rõ ràng giúp giảm công việc bị bỏ dở và hữu ích hơn lời hứa hợp nhất mọi đóng góp.

Câu hỏi thường gặp

CONTRIBUTING.md có thay thế README.md không?

Không. README giải thích dự án và cách dùng. Hướng dẫn đóng góp giải thích cách đề xuất và kiểm chứng thay đổi.

Có nên sao chép lệnh kiểm thử của dự án khác không?

Chỉ khi chúng cũng là lệnh đúng cho dự án của bạn. Thay chỗ giữ chỗ bằng lệnh đã thực sự kiểm tra.

Hướng dẫn đóng góp có bảo đảm thêm người đóng góp không?

Không. Chúng giảm sự mơ hồ cho người quan tâm, nhưng tính hữu ích của dự án, chất lượng nhiệm vụ và sự theo sát của người duy trì vẫn quan trọng.

Tài liệu tham khảo