Moddable-OpenSource / moddable-jp

for Japanese language translation of Moddable SDK documentation

5 stars 3 forks source link

Closed stc1988 closed 2 months ago

stc1988 commented 4 months ago

Moddable本体のリポジトリでドキュメントが修正・追加された時のフローを検討したいです。

実際に作業をしてみないと分からない部分がありますが、以下に検討事項を記載します

翻訳前のドキュメントないし新規追加ドキュメントについては、本リポジトリを本体リポジトリとSync?することで最新化できるのか
- どのタイミングで最新化するのか
- ドキュメント(*.md)が更新されたことを検知する仕組みが必要か
翻訳済みドキュメントは本体リポジトリと取り込み時にコンフリクトが起きるはずなので、そこで差分を翻訳してコンフリクトを解消するのか
- コンフリクト量が多いと最新化作業のコストが高くなるので、頻度は空けすぎない方がよいか

meganetaaan commented 3 months ago

下記のようなフローを想定しています。

Moddable本体の月次リリース毎にマージ作業を行う
dev/translate-jpブランチからマージ用のブランチ（merge/v4.6.0 など）を切る
Moddable本体のpublicブランチ（リリースタグのついたコミット）をマージ用ブランチにマージする
- 翻訳済みドキュメントに差分がある場合: コンフリクトの形で現れるので、該当箇所を改めて翻訳する
- 翻訳済みドキュメントに差分が無い場合: そのままfast-forwardでマージできるはず
マージ用のブランチからdev/translate-jpに対してPRを作成する
レビュー＆マージする

まずは月に1回でやってみて、1回のマージにかかる負担を様子見したいと思います。もうすぐ5月分の月次リリースが来ると思うので↑で試してみましょうか。

stc1988 commented 3 months ago

５月リリースをお試しで提案いただいたフローで問題ないです。確か #11 でリンク先を修正したぐらいがコンフリクトするはずです。

stc1988 commented 3 months ago

Moddable SDK 4.7.0がリリースされたので、取り込みをお願い出来ますでしょうか

stc1988 commented 2 months ago

25 にて最新の取り込み済み。

translation_readme.md記載の手順ともズレもなかったため、最新のドキュメント取り込み方法としては問題は無さそうなので、本件はクローズします