Đóng góp cho SubQuery

2021-10-17 Khoảng 3 phút

# Đóng góp cho SubQuery

Chào mừng và cảm ơn bạn đã cân nhắc đóng góp cho dự án SubQuery! Cùng nhau, chúng ta có thể mở ra một tương lai phi tập trung hơn.

Tài liệu này được duy trì tích cực bởi nhóm SubQuery. Chúng tôi hoan nghênh những đóng góp của bạn, bạn có thể làm như vậy bằng cách tạo ra dự án GitHub của chúng tôi và thực hiện các thay đổi đối với tất cả các tệp đánh dấu tài liệu trong danh mục docs.

Sau đây là một tập hợp các nguyên tắc (không phải quy tắc) trong việc đóng góp vào SubQuery. Việc tuân theo các nguyên tắc này sẽ giúp chúng tôi thực hiện quá trình đóng góp dễ dàng và hiệu quả cho người tham gia. Nó có mang nghĩa rằng bạn đồng ý tôn trọng thời gian của các nhà phát triển quản lý và phát triển dự án này. Đổi lại, chúng tôi sẽ đáp lại sự tôn trọng đó bằng cách giải quyết vấn đề của bạn, xem xét các thay đổi, cộng tác để cải tiến và giúp bạn hoàn thiện các yêu cầu kéo của mình.

# Quy tắc ứng xử

Chúng tôi coi trọng các dự án và trách nhiệm cộng đồng nguồn mở của mình, đồng thời tuân theo các tiêu chuẩn cao về giao tiếp cùng những người đóng góp khác. Bằng cách tham gia và đóng góp vào dự án này, bạn đồng ý tuân thủ Quy tắc ứng xử (opens new window) của chúng tôi.

# Bắt đầu

Các khoản đóng góp cho kho lưu trữ của chúng tôi được thực hiện thông qua Sự cố và Yêu cầu kéo (PR). Một số nguyên tắc chung bao gồm cả hai:

  • Tìm kiếm các Vấn đề và PR hiện có trước khi tự làm.
  • Chúng tôi làm việc chăm chỉ để đảm bảo các vấn đề được xử lý kịp thời nhưng có thể mất một khoảng thời gian để điều tra nguyên nhân gốc rễ tùy thuộc vào mức độ ảnh hưởng,. Đề cập @ thiện chí trong chuỗi bình luận dưới bài viết của người gửi hoặc người đóng góp giúp thu hút sự chú ý nếu vấn đề của bạn đang bị chặn.

# Cách đóng góp

# Báo cáo lỗi

Lỗi được theo dõi là sự cố GitHub. Khi ghi nhật ký sự cố, hãy giải thích sự cố và bao gồm các chi tiết bổ sung để giúp người bảo trì tái tạo sự cố:

  • Sử dụng tiêu đề rõ ràng và mang tính mô tả cho vấn đề để xác định vấn đề.
  • Mô tả các bước chính xác để tái tạo vấn đề.
  • Mô tả hành vi bạn đã quan sát được sau khi làm theo các bước.
  • Giải thích hành vi nào bạn muốn thấy và tại sao.
  • Bao gồm ảnh chụp màn hình nếu có.

# Gửi yêu cầu kéo

Nói chung, chúng tôi tuân theo quy trình làm việc Git "fork-and-pull"

  • Chuyển kho lưu trữ vào tài khoản Github của riêng bạn
  • Sao chép dự án vào máy của bạn
  • Tạo một nhánh cục bộ với tên ngắn gọn nhưng mô tả đầy đủ
  • Cam kết các thay đổi đối với chi nhánh
  • Tuân theo mọi nguyên tắc định dạng và kiểm tra cụ thể cho repo này
  • Đẩy các thay đổi đối với ngã ba của bạn
  • Mở một bài PR trong kho lưu trữ của chúng tôi

# Quy ước mã hóa

# Thông báo cam kết Git

  • Sử dụng thì hiện tại ("Thêm tính năng" không phải "Đã thêm tính năng")
  • Sử dụng tâm trạng bắt buộc ("Di chuyển con trỏ tới ..." chứ không phải "Di chuyển con trỏ tới ...")
  • Giới hạn dòng đầu tiên trong vòng 72 ký tự trở xuống

# Hướng dẫn định kiểu JavaScript

  • Tất cả mã JavaScript được in bằng Prettier và ESLint
Last Updated: October 17, 2021 08:07