4paradigm / 4paradigm/OpenMLDB

documents about how to develop for developers

オープン 初心者向け
#1,811 コメント 2 件 リアクション 1 件 担当者 1 名 @aceforeverd が担当を希望しています GitHub で見る
documentation
主要言語
C++
スター
1.7k
フォーク
331
平均マージ
12日 12時間
マージ済み PR(30日)
1

説明

**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.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
markdown
領域
developer-experience, documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
75/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。