CONTRIBUTING.md

Đóng góp vào hoa-utils

Cảm ơn bạn đã quan tâm đến việc đóng góp cho dự án hoa-utils! Chúng tôi rất vui mừng được chào đón mọi đóng góp từ cộng đồng. Bằng cách tham gia, bạn sẽ giúp cải thiện và phát triển thư viện tiện ích JavaScript này.

Quy trình đóng góp

1. Báo cáo lỗi: Nếu bạn phát hiện ra bất kỳ lỗi nào trong thư viện, vui lòng mở một issue mới và cung cấp càng nhiều chi tiết càng tốt để chúng tôi có thể xử lý.

2. Yêu cầu tính năng mới: Nếu bạn có ý tưởng cho một tính năng mới, hãy mở một issue mới và mô tả chi tiết tính năng đó. Chúng tôi sẽ xem xét và thảo luận về nó.

3. Gửi pull request: Nếu bạn muốn đóng góp mã nguồn, hãy fork dự án, tạo một nhánh mới, thực hiện các thay đổi của bạn và gửi một pull request. Đảm bảo rằng mã nguồn của bạn tuân theo các quy ước mã nguồn được mô tả bên dưới.

Hướng dẫn phát triển

1. Thiết lập môi trường:

   • Cài đặt Node.js và npm.
   • Fork dự án và clone repo của bạn.
   • Chạy npm install để cài đặt các phụ thuộc.

2. Công cụ và thư viện:

   • Dự án sử dụng Jest để viết và chạy bộ kiểm thử.
   • Mã nguồn được định dạng bằng Prettier.

3. Xây dựng và kiểm thử:

   • Chạy npm run build để xây dựng dự án.
   • Chạy npm test để chạy bộ kiểm thử.
   • Chạy npm run format để định dạng mã nguồn với Prettier.

Quy ước mã nguồn

• Sử dụng cú pháp ES6+ cho mã nguồn JavaScript.
• Tuân theo quy ước đặt tên JavaScript tiêu chuẩn.
• Viết mã nguồn rõ ràng, dễ đọc và đầy đủ nhận xét.
• Viết bộ kiểm thử cho mọi chức năng mới hoặc thay đổi.

Quy tắc ứng xử

Chúng tôi cam kết duy trì một môi trường cộng đồng thân thiện và đầy tôn trọng. Vui lòng đọc Quy tắc ứng xử của chúng tôi để biết thêm chi tiết.

Liên hệ

Nếu bạn có bất kỳ câu hỏi nào, vui lòng liên hệ với Đặng Phúc Hòa qua email: [email protected] của chúng tôi.

Cảm ơn bạn đã quan tâm đến dự án hoa-utils! Chúng tôi rất mong nhận được đóng góp của bạn.