Bỏ qua nội dung chính

Đóng góp cho SubQuery

SubQuery TeamKhoảng 2 phút

Đóng góp cho SubQuery

Chào mừng và chân thành 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ở đường cho một tương lai phi tập trung hơn.

Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. :::

Sau đây là một tập hợp các nguyên tắc (không phải quy tắc) để đóng góp vào SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests.

Quy tắc ứng xử

We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conductopen in new window.

Bắt đầu

Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both:

  • 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 tùy thuộc vào mức độ ảnh hưởng, có thể mất một khoảng thời gian để điều tra nguyên nhân gốc rễ. Đề cập @ thân thiện trong chuỗi nhận xét cho người gửi hoặc người đóng góp có thể 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

Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem:

  • 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ả trạng thái 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ó thể.

Gửi Pull Requests

In general, we follow the "fork-and-pull" Git workflow:

  • Fork the repository to your own Github account.
  • Clone the project to your machine.
  • Create a branch locally with a succinct but descriptive name.
  • Commit changes to the branch.
  • Following any formatting and testing guidelines specific to this repo.
  • Push changes to your fork.
  • Open a PR in our repository.

Quy ước mã hóa

Thông báo cam kết Git

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.

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

  • All JavaScript code is linted with Prettier and ESLint.