4paradigm / 4paradigm/OpenMLDB

documents about how to develop for developers

Đang mở Phù hợp với người mới
#1,811 2 bình luận 1 reaction 1 người được giao Được @aceforeverd nhận Xem trên GitHub
documentation
Ngôn ngữ chính
C++
Star
1.7k
Fork
331
Merge trung bình
12 ngày 12 giờ
Pull request đã merge (30 ngày)
1

Mô tả

**Describe the feature you'd like**

Need documents about how to compile, test and deploy for developers

- we can add a `development.md` in docs/*/developer/, to summary all modules and development method
- add the development guide entry in `CONTIRBUTING.md` file
- for each specific module
- we can put `README` in each directory for a simple and quick introduction
- any detail or advanced guide/usage, can appear in `docs` directory, which also available in doc website
- add the `Maintain.md` for instruction like release workflow

**Additional context**

Add any other context or screenshots about the feature request here.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Look at the existing docs/*/developer/ directory and CONTRIBUTING.md to understand the current structure. The task involves creating a new development.md file summarizing modules and development methods, updating CONTRIBUTING.md to link to it, and possibly adding README files in module directories. Check the repository's root and docs layout to see where files should be placed.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
markdown
Lĩnh vực
developer-experience, documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
75/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.